add release.md

vitalets · Dec 19, 2024 · a62babc · a62babc
1 parent c0457cc
commit a62babc
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/.github/RELEASE.md b/.github/RELEASE.md
@@ -0,0 +1,12 @@
+# Releasing Playwright-BDD
+
+Currently release is performed from the local machine.
+
+1. push `main` branch to GitHub and wait all checks to pass
+2. manually set new version in CHANGELOG.md, then run `git commit -am'changelog: bump xxx'`
+3. `npm run release`
+4. update playwright-bdd-example: `npm i -D playwright-bdd@latest`
+5. merge `main` branch to `docs` to update documentation website:
+  - `git co docs && git pull && git merge main && git push && git co main`
+  - check docs: https://vitalets.github.io/playwright-bdd/
+6. close relevant issues on GitHub by Changelog