Merge pull request #1222 from pkp/dev-plugin-release

Add full plugin CLI release command
pkp · Jul 9, 2024 · 5f43b3e · 5f43b3e
2 parents 8e5f66a + e81f2b5
commit 5f43b3e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/dev/plugin-guide/3.3/en/release.md b/dev/plugin-guide/3.3/en/release.md
@@ -36,10 +36,10 @@ We provide a [CLI tool](https://github.com/pkp/pkp-plugin-cli/) that can help yo
 npm install -g pkp-plugin-cli
 ```
 
-Use the following to build a release package and upload it as a release to your repository on GitHub.
+Use the following to build a release package and upload it as a release to your repository on GitHub, replacing the plugin name and version number with your own.
 
 ```
-pkp-plugin release
+pkp-plugin release pluginName --newversion 1.0.0.0
 ```
 
 > Any non-essential files provided by your dependency manager (eg - composer, npm) should not be included with the package. These often include demos and examples that can be security risks when uploaded to the plugins directory.

diff --git a/dev/plugin-guide/en/release.md b/dev/plugin-guide/en/release.md
@@ -40,10 +40,10 @@ We provide a [CLI tool](https://github.com/pkp/pkp-plugin-cli/) that can help yo
 npm install -g pkp-plugin-cli
 ```
 
-Use the following to build a release package and upload it as a release to your repository on GitHub.
+Use the following to build a release package and upload it as a release to your repository on GitHub, replacing the plugin name and version number with your own.
 
 ```
-pkp-plugin release
+pkp-plugin release pluginName --newversion 1.0.0.0
 ```
 
 ## Get the Plugin into the Plugin Gallery