From 19ef25032ef94db23e14258695e2af6482675158 Mon Sep 17 00:00:00 2001 From: Shubham Kumar <90208766+shubhamkd@users.noreply.github.com> Date: Thu, 11 Dec 2025 15:05:14 +0530 Subject: [PATCH 1/2] Document release process for Nightwatch plugin Added detailed release process steps for the Nightwatch Browserstack plugin. --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 1b21193..7e8ec91 100644 --- a/README.md +++ b/README.md @@ -38,5 +38,38 @@ module.exports = { // other nightwatch settings... } ``` + +## 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 `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`. +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 3.7.0 + ``` +10. Push commits **and tags**: + ```sh + git push --tags + ``` +11. **Publish the package:** + ```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._ +12. **Create a release on GitHub:** + - Select the new tag. + - Generate release notes. + - Publish the release. + ## License MIT From 215ab287289bd24856721a1d64ebedfad20cc7d2 Mon Sep 17 00:00:00 2001 From: Shubham Kumar <90208766+shubhamkd@users.noreply.github.com> Date: Thu, 11 Dec 2025 15:09:59 +0530 Subject: [PATCH 2/2] Update git tag and push commands in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7e8ec91..4c932b4 100644 --- a/README.md +++ b/README.md @@ -55,11 +55,11 @@ Follow these steps when releasing the Nightwatch Browserstack plugin: _Release commit names should match the version number, e.g., `3.7.0`._ 9. Add a tag: ```sh - git tag 3.7.0 + git tag v3.7.0 ``` 10. Push commits **and tags**: ```sh - git push --tags + git push origin main --tags ``` 11. **Publish the package:** ```sh