Skip to content

Commit 19ef250

Browse files
authored
Document release process for Nightwatch plugin
Added detailed release process steps for the Nightwatch Browserstack plugin.
1 parent be745e1 commit 19ef250

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,5 +38,38 @@ module.exports = {
3838
// other nightwatch settings...
3939
}
4040
```
41+
42+
## Release Process
43+
44+
Follow these steps when releasing the Nightwatch Browserstack plugin:
45+
46+
1. **Merge the corresponding pull request (PR)** using squash and merge.
47+
2. **Clone a fresh copy of the repository locally** to avoid publishing uncommitted files.
48+
3. Run `npm install` (or `npm i`) to install dependencies.
49+
4. Run `npm audit fix` to automatically resolve fixable vulnerabilities.
50+
_Note: This only changes `package-lock.json`. It is safer than using `--force`, which may change package versions unexpectedly._
51+
5. **Commit and push** any changes resulting from `npm audit fix`.
52+
6. **Bump the version** in `package.json` (e.g., `3.6.2``3.7.0` for a minor bump).
53+
7. Run `npm install` again to update `package-lock.json` after the version bump.
54+
8. **Stage and commit** the version bump changes.
55+
_Release commit names should match the version number, e.g., `3.7.0`._
56+
9. Add a tag:
57+
```sh
58+
git tag 3.7.0
59+
```
60+
10. Push commits **and tags**:
61+
```sh
62+
git push --tags
63+
```
64+
11. **Publish the package:**
65+
```sh
66+
npm publish
67+
```
68+
_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._
69+
12. **Create a release on GitHub:**
70+
- Select the new tag.
71+
- Generate release notes.
72+
- Publish the release.
73+
4174
## License
4275
MIT

0 commit comments

Comments
 (0)