mirror of
https://github.com/mandiant/capa.git
synced 2026-01-17 23:25:50 -08:00
400e28c3f7
* doc: add rules documentation * version: add accessor for capa major version and git checkout command * doc: rules: document version output * doc: rules: show example error due to mismatched rule version * doc: rules: update links * ci: tag major rule version test * ci: tag major rule version * doc: update changelog * ci: force to replace tag if exists * ci: simplify tagging step * Update doc/rules.md * feat: disable tag, show error branch cmd * doc: update major version rules branch * Apply suggestions from code review Co-authored-by: Willi Ballenthin <willi.ballenthin@gmail.com> * Update capa/main.py * black Co-authored-by: Moritz Raabe <moritz.raabe@mandiant.com> Co-authored-by: Moritz <mr-tz@users.noreply.github.com>
50 lines
2.7 KiB
Markdown
50 lines
2.7 KiB
Markdown
# Release checklist
|
|
|
|
- [ ] Ensure all [milestoned issues/PRs](https://github.com/mandiant/capa/milestones) 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](https://github.com/mandiant/capa/pulls) and [capa-rules](https://github.com/mandiant/capa-rules/pulls).
|
|
- [ ] Ensure the [CI workflow succeeds in master](https://github.com/mandiant/capa/actions/workflows/tests.yml?query=branch%3Amaster).
|
|
- [ ] Ensure that `python scripts/lint.py rules/ --thorough` succeeds (only `missing examples` offenses are allowed in the nursery).
|
|
- [ ] Review changes
|
|
- capa https://github.com/mandiant/capa/compare/\<last-release\>...master
|
|
- capa-rules https://github.com/mandiant/capa-rules/compare/\<last-release>\...master
|
|
- [ ] Update [CHANGELOG.md](https://github.com/mandiant/capa/blob/master/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: see template below
|
|
- Update `Raw diffs` links
|
|
- Create placeholder for `master (unreleased)` section
|
|
```
|
|
## master (unreleased)
|
|
|
|
### New Features
|
|
|
|
### Breaking Changes
|
|
|
|
### New Rules (0)
|
|
|
|
-
|
|
|
|
### Bug Fixes
|
|
|
|
### capa explorer IDA Pro plugin
|
|
|
|
### Development
|
|
|
|
### Raw diffs
|
|
- [capa <release>...master](https://github.com/mandiant/capa/compare/<release>...master)
|
|
- [capa-rules <release>...master](https://github.com/mandiant/capa-rules/compare/<release>...master)
|
|
```
|
|
- [ ] Update [capa/version.py](https://github.com/mandiant/capa/blob/master/capa/version.py)
|
|
- [ ] Create a PR with the updated [CHANGELOG.md](https://github.com/mandiant/capa/blob/master/CHANGELOG.md) and [capa/version.py](https://github.com/mandiant/capa/blob/master/capa/version.py). Copy this checklist in the PR description.
|
|
- [ ] After PR review, merge the PR and [create the release in GH](https://github.com/mandiant/capa/releases/new) using text from the [CHANGELOG.md](https://github.com/mandiant/capa/blob/master/CHANGELOG.md).
|
|
- [ ] Verify GH actions [upload artifacts](https://github.com/mandiant/capa/releases), [publish to PyPI](https://pypi.org/project/flare-capa) and [create a tag in capa rules](https://github.com/mandiant/capa-rules/tags) upon completion.
|
|
- [ ] Manually update capa rules major version rule branch
|
|
```commandline
|
|
[capa/rules] $ git pull master
|
|
[capa/rules] $ git checkout v3 # create if new major version: git checkout -b vX
|
|
[capa/rules] $ git merge master
|
|
[capa/rules] $ git push origin v3
|
|
```
|
|
- [ ] [Spread the word](https://twitter.com)
|
|
- [ ] Update internal service
|