Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.19 KB

RELEASE_CHECKLIST.md

File metadata and controls

54 lines (37 loc) · 2.19 KB

Release checklist

This checklist is meant to be used as a guide for the aderyn release process.

Releases are always made in lockstep, meaning that all crates in the repository are released with the same version number, regardless of whether they have changed or not.

Requirements

Stay logged in with gh auth login

Pre-requisites

  • Code in the dev branch must be in good shape for release.
  • If there are breaking changes, a newer version of VSCode extension is ready to be released in it's main branch.

Steps

  • Cut a release.

    • Switch to dev branch and pull latest changes.
    • Run cargo patch. Wait until the command is fully done.
    • Generate Release Notes in the Github's Release page

  • NOTE: Expect the following in CI:

    • Sarif report tests fail because of version mismatch.
    • After the building of global artifacts, aderyn_driver and aderyn_core crates fail to publish.
    • Binary crate aderyn is successfully published.

  • Create a checkpoint on master.

    • Run git checkout master && git pull
    • Run git checkout -b master-merge-<version-to-be-released>.
    • Merge dev into it and preserve all changes in dev. git merge --squash -X theirs dev.
    • Sometimes if conflicts are not auto-resolved, pick to keep all the changes from dev
    • Merge it back to master by creating a PR (Verify CI tests)

  • Switch back to dev branch with git checkout dev.

NOTE: Replace patch with minor based on the needs.

Breaking change

If at least one of the following is observed, it's considered a breaking change. In that case, the minor version must be bumped at a minimum. This ensures the VS Code extension remains compatible, as users will be prompted to install the updated version.

  • Changes in CLI flags - --lsp, --json, --stdout
  • Changes in the JSON output format.
  • Arbitrary Changes to LSP server.
  • Changes to asset names or URLs in Github Releases.
  • Changes to aderyn.toml template.

Above is a non-exhaustive list There can be more.