From 983cefb3db3fd9920ded6293fdd9c83cf3fe822b Mon Sep 17 00:00:00 2001 From: Shubham Kumar <90208766+shubhamkd@users.noreply.github.com> Date: Thu, 11 Dec 2025 15:13:37 +0530 Subject: [PATCH 1/3] Add release process documentation to RELEASE.md Document the release process for the Nightwatch Browserstack plugin, including steps for merging, version bumping, and publishing. --- RELEASE.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..10158d4 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,35 @@ +## Release Process + +Follow these steps when releasing the Nightwatch Browserstack plugin: + +1. **Merge the corresponding pull request (PR)** using squash and merge. +2. **Clone a fresh copy of the repository locally** to avoid publishing uncommitted files. +3. Run `npm install` (or `npmi`) to install dependencies. +4. Run `npm audit fix` to automatically resolve fixable vulnerabilities. + _Note: This only changes `package-lock.json`. It is safer than using `--force`, which may change package versions unexpectedly._ +5. **Commit and push** any changes resulting from `npm audit fix`. +6. **Bump the version** in `package.json` (e.g., `3.6.2` → `3.7.0` for a minor bump). +7. Run `npm install` again to update `package-lock.json` after the version bump. +8. **Stage and commit** the version bump changes. + _Release commit names should match the version number, e.g., `3.7.0`._ +9. Add a tag: + ```sh + git tag v3.7.0 + ``` +10. Push commits **and tags**: + ```sh + git push origin main --tags + ``` +11. **Login to npm (if not already authenticated):** + ```sh + npm login + ``` + _Requires an npm account with permission for this package (typically by joining the Nightwatch organization on npm). For accounts with 2FA, a mobile verification code will be requested._ +12. **Publish the package to npm:** + ```sh + npm publish + ``` +13. **Create a release on GitHub:** + - Select the new tag. + - Generate release notes. + - Publish the release. From 39e933b8df142a50ab00631b480c94291a4c9c1e Mon Sep 17 00:00:00 2001 From: Shubham Kumar <90208766+shubhamkd@users.noreply.github.com> Date: Thu, 11 Dec 2025 15:14:06 +0530 Subject: [PATCH 2/3] Fix typo in npm install command --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 10158d4..b4a6e94 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -4,7 +4,7 @@ Follow these steps when releasing the Nightwatch Browserstack plugin: 1. **Merge the corresponding pull request (PR)** using squash and merge. 2. **Clone a fresh copy of the repository locally** to avoid publishing uncommitted files. -3. Run `npm install` (or `npmi`) to install dependencies. +3. Run `npm install` (or `npm i`) to install dependencies. 4. Run `npm audit fix` to automatically resolve fixable vulnerabilities. _Note: This only changes `package-lock.json`. It is safer than using `--force`, which may change package versions unexpectedly._ 5. **Commit and push** any changes resulting from `npm audit fix`. From c8ca93efc16d364bdcda1ec4cc8b5e30f4f03881 Mon Sep 17 00:00:00 2001 From: Shubham Kumar <90208766+shubhamkd@users.noreply.github.com> Date: Thu, 11 Dec 2025 15:16:13 +0530 Subject: [PATCH 3/3] Update npm account requirements in RELEASE.md Clarified npm account requirements for publishing. --- RELEASE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index b4a6e94..cbb6f9d 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -24,11 +24,12 @@ Follow these steps when releasing the Nightwatch Browserstack plugin: ```sh npm login ``` - _Requires an npm account with permission for this package (typically by joining the Nightwatch organization on npm). For accounts with 2FA, a mobile verification code will be requested._ + _Requires an npm account._ 12. **Publish the package to npm:** ```sh npm publish ``` + _Requires an npm account with permission for this package (typically by joining the Nightwatch organization on npm). For accounts with 2FA, a mobile verification code will be requested._ 13. **Create a release on GitHub:** - Select the new tag. - Generate release notes.