Skip to content

Commit 547141f

Browse files
authored
Merge pull request #1006 from AikidoSec/docs-release-process
Add release process doc
2 parents f856875 + c982e3d commit 547141f

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

.github/RELEASE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# firewall-node Release Process
2+
3+
## 1. Before the release
4+
5+
Ensure that all tests are passing on main branch and that the code is ready for release.
6+
7+
## 2. Create a GitHub release
8+
9+
Create a new release in the [GitHub UI](https://github.com/AikidoSec/firewall-node/releases/new).
10+
Use the version number without the "v" prefix (e.g. "1.0.0") as the tag and release title.
11+
Write a clean release description intended for users, summarizing the changes in this release and optional links to relevant docs.
12+
13+
## 3. Monitor release workflow
14+
15+
On creation of the release, a GitHub Actions workflow will be triggered to build and publish the package to npm.
16+
Monitor [the workflow](https://github.com/AikidoSec/firewall-node/actions/workflows/build-and-release.yml) for any errors and ensure that the release is published successfully.
17+
Sometimes tests may fail, restart them if they do and monitor until they pass.
18+
19+
## 4. After the release
20+
21+
Update the [Zen Demo Node.js](https://github.com/Aikido-demo-apps/zen-demo-nodejs) to use the new version and ensure that it works correctly with the new release (CJS & ESM instances).
22+
Also update the [Aikido Docs](https://help.aikido.dev) if any documentation in the repository has changed.

0 commit comments

Comments
 (0)