Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit a16fcb2

Browse files
committedDec 10, 2024·
(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.
1 parent cca46ed commit a16fcb2

6 files changed

+87
-42
lines changed
 
Loading
Loading
Loading
Loading
Loading

‎docs/plugins/private-plugins.md

+87-42
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,6 @@ Never use the same repository for private plugins and generated services to avoi
4343

4444
![Publish Your Platform Console Changes](./assets/private-plugins/configure-git-settings.png)
4545

46-
## Add a New Private Plugin
47-
48-
Next, add a new private plugin to your Platform Console:
49-
50-
1. In the Private Plugins tab's sidebar, click the `Add Private Plugin` field
51-
2. Enter a unique name using kebab-case (e.g., `acme-corp-authentication`)
52-
3. Set the plugin's **Display Name** and **Description** - these will appear in the UI when selecting plugins
53-
4. Choose the appropriate code generator (Node.js or .NET) that matches your target services
54-
55-
![Publish Your Platform Console Changes](./assets/private-plugins/add-new-plugin.png)
56-
5746
## Set Up Your Private Plugin Folder
5847

5948
After creating the plugin entry in the Platform Console, set up your development environment.
@@ -122,54 +111,72 @@ Follow the steps below to complete this process:
122111
mv plugins/dotnet-db-postgres your-plugin-id
123112
```
124113

125-
## Develop Your Plugin
114+
## Add a New Private Plugin
126115

127-
Now that your plugin structure is set up, it's time to start building your plugin.
128-
We've prepared several resources and reference materials to help guide your plugin development process.
116+
Next, add a new private plugin to your Platform Console:
129117

130-
Core Documentation:
118+
1. In the Private Plugins tab's sidebar, click the `Add Private Plugin` field
119+
2. A modal appears that scans your connected Git repository for private plugins
120+
3. Select your plugin from the list of found plugins
131121

132-
- [Private Plugins Overview](https://docs.amplication.com/plugins/overview/)
133-
- [.NET Plugin Events Reference Guide](https://docs.amplication.com/plugins/dotnet-plugin-events/create-server/)
134-
- [Node.js Plugin Events Reference Guide](https://docs.amplication.com/plugins/plugin-events/create-server/)
122+
:::note
123+
Only plugins that are properly structured within the `plugins` folder of your connected Git repository will be detected.
124+
:::
135125

136-
Community Plugin Examples:
126+
![Publish Your Platform Console Changes](./assets/private-plugins/add-new-plugin.png)
137127

138-
- Browse the [official plugins repository](https://github.com/amplication/plugins/tree/master/plugins) for real-world examples
128+
## Configure Your Plugin
139129

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.
142144
:::
143145

144-
## Add Versions to Your Plugin
146+
![Configure Your Private Plugin's Settings](./assets/private-plugins/configure-plugin.png)
145147

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
148149

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.
152151

153-
![Publish Your Platform Console Changes](./assets/private-plugins/add-new-version.png)
152+
First, enable dev versions by toggling the `Enable Dev Version` into the on state.
154153

155-
## Tag Your Git Repository
154+
![Enable Dev Versions](./assets/private-plugins/enable-dev-versions.png)
156155

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.
159158

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.
161162

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.
165164

166-
Push the tag to your remote repository:
165+
Core Documentation:
167166

168-
```bash
169-
git push origin "your-plugin-id@0.1.0"
170-
```
167+
- [Private Plugins Overview](https://docs.amplication.com/plugins/overview/)
168+
- [.NET Plugin Events Reference Guide](https://docs.amplication.com/plugins/dotnet-plugin-events/create-server/)
169+
- [Node.js Plugin Events Reference Guide](https://docs.amplication.com/plugins/plugin-events/create-server/)
170+
171+
Community Plugin Examples:
171172

172-
## Configure Plugin Settings
173+
- 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
173180

174181
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.
175182

@@ -196,7 +203,45 @@ For a real-world example of using settings in your plugin, see the [Supertokens
196203

197204
## Publish Your Plugin
198205

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+
![Disable Dev Versions](./assets/private-plugins/disable-dev-version.png)
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+
![Publish Your Platform Console Changes](./assets/private-plugins/add-new-version.png)
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
200245

201246
1. Go to your Platform Console
202247
2. Click on "Publish New Version" in your Platform Changes sidebar

0 commit comments

Comments
 (0)
This repository has been archived.