docs: add doc to release the migration script

Cosmo-Tech · Mar 3, 2023 · 6e81a97 · 6e81a97
1 parent 81f539b
commit 6e81a97
Showing 1 changed file with 24 additions and 2 deletions.
diff --git a/scripts/migration/README.md b/scripts/migration/README.md
@@ -19,11 +19,11 @@ nvm use 16
 
 ## Migrate from v2 to v3
 
-`npx @cosmotech/migrate-azure-sample-webapp v3`
+`npx @cosmotech/migrate-azure-sample-webapp@latest v3`
 
 ## Migrate from v4 to v5
 
-`npx @cosmotech/migrate-azure-sample-webapp v5 [-s path/to/your/solution.yaml] [-w path/to/your/workspace.yaml]`
+`npx @cosmotech/migrate-azure-sample-webapp@latest v5 [-s path/to/your/solution.yaml] [-w path/to/your/workspace.yaml]`
 
 Optional parameters:
 
@@ -38,3 +38,25 @@ Optional parameters:
 
 - `cd` to the folder containing the migration scripts (with files `migrate.js` and `package.json`) and run `npm link`
 - `cd` to the folder where you want to run the migration scripts, and run `migrate-azure-sample-webapp v5`
+
+## Release a new version of the migration script
+
+For an official release:
+
+```sh
+npm version X.X.X --no-git-tag-version  # Replace X.X.X by the new version number
+git add package.json
+git commit -m "chore: bump migration script package version to X.X.X for release"  # Replace X.X.X here too
+npm login
+npm publish
+```
+
+For a non-official "dev" release:
+
+```sh
+npm version X.X.X-dev.X --no-git-tag-version  # Replace X.X.X-dev.X by the new version number
+git add package.json
+git commit -m "chore: bump migration script package version to X.X.X-dev.X for release"  # Replace X.X.X-dev.X here too
+npm login
+npm publish --tag dev
+```