capa/doc/release.md

Release checklist

• Ensure all milestoned issues/PRs are addressed, or reassign to a new milestone.
• Add the dont merge label to all PRs that are close to be ready to merge (or merge them if they are ready) in capa and capa-rules.
• Ensure the CI workflow succeeds in master.
• Ensure that python scripts/lint.py rules/ --thorough succeeds (only missing examples offenses are allowed in the nursery).
• Review changes
  • capa https://github.com/fireeye/capa/compare/<last-release>...master
  • capa-rules https://github.com/fireeye/capa-rules/compare/<last-release>...master
• Update CHANGELOG.md
  • Do not forget to add a nice introduction thanking contributors
  • Remember that we need a major release if we introduce breaking changes
  • Sections
    • New Features
    • New Rules
    • Bug Fixes
    • Changes
    • Development
    • Raw diffs
  • Update Raw diffs links
  • Create placeholder for master (unreleased) section

    ## master (unreleased)
    
    ### New Features
    
    ### New Rules
    
    ### Bug Fixes
    
    ### Changes
    
    ### Development
    
    ### Raw diffs
    - [capa <release>...master](https://github.com/fireeye/capa/compare/<release>...master)
    - [capa-rules <release>...master](https://github.com/fireeye/capa-rules/compare/<release>...master)
    

• Update capa/version.py
• Create a PR with the updated CHANGELOG.md and capa/version.py. Copy this checklist in the PR description.
• After PR review, merge the PR and create the release in GH using text from the CHANGELOG.md.
• Verify GH actions upload artifacts, publish to PyPI and create a tag in capa rules upon completion.
• Spread the word