How to Release
Release process for project maintainers.
Release Channels
| Channel | Package Name & Link | Release Process |
|---|---|---|
| Homebrew (Core) | noir | Manual |
| Homebrew (Tap) | owasp-noir/noir |
Automated |
| Snapcraft | noir | Automated |
| Docker Hub | ghcr.io/owasp-noir/noir | Automated |
| OWASP Project Page | OWASP/www-project-noir | Manual |
General Procedure
-
Update Version: Update the version in source code and documentation.
-
Verify Version Consistency: Run the version check to ensure all files match:
just version-check # or just vcAll 13 tracked files must match the version in
shard.yml(all checks show ✅). -
Create GitHub Release: Publish a new release on the GitHub releases page. This triggers automated workflows.
-
Manual Releases: Complete the manual steps below for non-automated channels.
Manual Release Instructions
Homebrew (Core)
Submit a PR to homebrew-core:
-
Fork and Sync: Keep your fork of Homebrew/homebrew-core up-to-date.
-
Run the Bump Command:
brew bump-formula-pr --strict --version <VERSION> noir # Example: brew bump-formula-pr --strict --version 0.28.0 noir -
Style Check (Optional):
cd $(brew --repository)/Library/Taps/homebrew/homebrew-core/Formula brew style noir.rb
OWASP Project Page
Submit a PR to OWASP/www-project-noir with updated content.