Release Procedure

Release Targets

Name Package Name & Link  
Homebrew noir Manual
Homebrew (tap) noir Automated (Github action)
Snapcraft noir Automated (Github action)
Docker (ghcr.io) ghcr.io/owasp-noir/noir Automated (Github action)
OWASP Project Page OWASP/www-project-noir Manual

Procedure

  1. Check the package version in noir command and documents.
  2. Create a release on GitHub.
  3. Most releases are automated, handle only the items that require manual release.

Manual releases

Homebrew

Step-by-Step Guide

  1. Fork the Homebrew core repository: Homebrew/homebrew-core

    For personal use: Sync your fork (e.g., hahwul/homebrew-core)

  2. Generate a PR for the Homebrew core: 
    brew bump-formula-pr --strict --version <VERSION> noir
# Example: brew bump-formula-pr --strict --version 0.20.1 noir

Troubleshooting

If you encounter issues, try the following commands:

HOMEBREW_NO_INSTALL_FROM_API=1 brew update
brew bump-formula-pr --strict --version <VERSION_NUMBER> noir

Style Check

To ensure your changes adhere to Homebrew’s style guidelines:

cd $(brew --repository)/Library/Taps/homebrew/homebrew-core/Formula
brew style noir.rb

OWASP Project Page

  1. Sync your fork of the OWASP Noir project page: owasp-noir/www-project-noir
  2. Update the contents as needed.
  3. Create a PR to the main repository: OWASP/www-project-noir