You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 6, 2025. It is now read-only.
(docs): Making changes to the private plugins page to account for the new UI, the new flow, and account for dev versions. Adding new screenshots, and updating, various versions.
Only plugins that are properly structured within the `plugins` folder of your connected Git repository will be detected.
124
+
:::
135
125
136
-
Community Plugin Examples:
126
+

137
127
138
-
- Browse the [official plugins repository](https://github.com/amplication/plugins/tree/master/plugins) for real-world examples
128
+
## Configure Your Plugin
139
129
140
-
:::note
141
-
Study the published Node.js and .NET community plugins for best practices and guidance on how to structure your code effectively.
130
+
After adding your plugin, you'll need to configure its settings:
131
+
132
+
1.**Plugin ID**: Automatically set based on your plugin's folder name in the Git repository. This can only be modified by renaming the folder and re-adding the plugin.
133
+
2.**Display Name**: The human-readable name for your plugin that appears in the UI. By default, it matches the Plugin ID but can be customized for better clarity.
134
+
3.**Icon**: Choose from a variety of technology-specific icons to help visually identify your plugin. You can also customize the icon's color to match your categorization system.
135
+
4.**Code Generator**: Select the appropriate code generator for your plugin:
136
+
- Node.js
137
+
- .NET
138
+
- Blueprints (for custom blueprint solutions)
139
+
5.**Blueprint Compatibility**: Optionally restrict your plugin to work with specific blueprints by selecting them from the dropdown menu.
140
+
6.**Description**: Provide a detailed description of your plugin's purpose. A detailed description helps developers quickly understand and choose the right plugin for their needs.
141
+
142
+
:::tip
143
+
A meaningful display name, icon, and description will help developers quickly identify and understand your plugin's purpose when browsing the plugin list in services and templates.
142
144
:::
143
145
144
-
## Add Versions to Your Plugin
146
+

145
147
146
-
After developing your plugin, you'll need to version it both in Amplication and your Git repository.
147
-
First, let's add a version through the Amplication UI:
148
+
## Develop Your Plugin
148
149
149
-
1. Navigate to the Private Plugins tab and select your plugin
150
-
2. Scroll to **Add New Version** and click `Add Version`
151
-
3. Note the version number you assign (e.g., `0.1.0`)
150
+
Now that your plugin structure is set up, it's time to start building your plugin.
152
151
153
-

152
+
First, enable dev versions by toggling the `Enable Dev Version` into the on state.
154
153
155
-
## Tag Your Git Repository
154
+

156
155
157
-
Next, let's add a git tag to your plugin.
158
-
Amplication uses Git tags to identify plugin versions during code generation.
156
+
Dev Versions streamline the plugin development process by automatically using the latest code from your repository's base branch.
157
+
This eliminates the need to publish new versions during development and testing.
159
158
160
-
Create a tag with your Plugin ID and version from the previous step:
159
+
Dev Versions makes the development process much smoother.
160
+
The plugin code will be pulled from the base branch set at the Git Settings.
161
+
The new changes in your plugin folder are immediately available for testing.
161
162
162
-
```bash
163
-
git tag "your-plugin-id@0.1.0"
164
-
```
163
+
Next, we've prepared several resources and reference materials to help guide your plugin development process.
- Browse the [official plugins repository](https://github.com/amplication/plugins/tree/master/plugins) for real-world examples
174
+
175
+
:::note
176
+
Study the published Node.js and .NET community plugins for best practices and guidance on how to structure your code effectively.
177
+
:::
178
+
179
+
### Add Plugin Settings
173
180
174
181
Plugin settings allow you to define customizable options that users can configure when using your plugin. These settings can include API keys, feature flags, or other configuration values that modify your plugin's behavior.
175
182
@@ -196,7 +203,45 @@ For a real-world example of using settings in your plugin, see the [Supertokens
196
203
197
204
## Publish Your Plugin
198
205
199
-
After adding a version to your plugin, configuring your plugin settings, and tagging your repository, it's time to publish your plugin. Publishing makes your plugin version available for use in services and templates, and sets it as the latest version.
206
+
After developing your plugin it's time to get it for release.
207
+
To do this, you'll need to add a version to your plugin, tag your repository, and finally publish it through the Amplication UI.
208
+
209
+
Publishing makes your plugin version available for use in services and templates, and sets it as the latest version.
210
+
211
+
### Add Versions to Your Plugin
212
+
213
+
After developing your plugin and to get it ready for release, you'll need to version it in both Amplication and your Git repository.
214
+
215
+
First, disable dev versions by toggling the `Enable Dev Version` into the off state.
216
+
217
+

218
+
219
+
Next, let's add a version through the Amplication UI:
220
+
221
+
1. Navigate to the Private Plugins tab and select your plugin
222
+
2. Scroll to **Add New Version** and click `Add Version`
223
+
3. Note the version number you assign (e.g., `0.1.0`)
224
+
225
+

226
+
227
+
### Tag Your Git Repository
228
+
229
+
Next, let's add a git tag to your plugin.
230
+
Amplication uses Git tags to identify plugin versions during code generation.
231
+
232
+
Create a tag with your Plugin ID and version from the previous step:
233
+
234
+
```bash
235
+
git tag "your-plugin-id@0.1.0"
236
+
```
237
+
238
+
Push the tag to your remote repository:
239
+
240
+
```bash
241
+
git push origin "your-plugin-id@0.1.0"
242
+
```
243
+
244
+
### Publish Your Plugin
200
245
201
246
1. Go to your Platform Console
202
247
2. Click on "Publish New Version" in your Platform Changes sidebar
0 commit comments