Skip to content

docs: document release info updater #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
scotluns wants to merge 1 commit into
base: main
Choose a base branch
from
+30 −1
Open

docs: document release info updater #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion docs/RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,36 @@ just release-dry-run

### Updating ATT&CK Version Metadata

If releasing for a new ATT&CK version, update `LATEST_VERSION` in `mitreattack/release_info.py` before merging.
If releasing for a new ATT&CK version, update `mitreattack-python/release_info.py` after the corresponding STIX releases are published:

- STIX 2.0 hashes come from [mitre/cti](https://github.com/mitre/cti/releases)
- STIX 2.1 hashes come from [mitre-attack/attack-stix-data](https://github.com/mitre-attack/attack-stix-data/releases)

Preview the update first:

```bash
uv run --extra dev python scripts/update_release_info.py 19.1 --dry-run
```

Apply it:

```bash
uv run --extra dev python scripts/update_release_info.py 19.1
```

The updater refreshes:

- `LATEST_VERSION`
- `STIX20["enterprise"]`, `STIX20["mobile"]`, `STIX20["ics"]`
- `STIX21["enterprise"]`, `STIX21["mobile"]`, `STIX21["ics"]`

Then verify:

```bash
uv run --extra dev ruff check scripts/update_release_info.py tests/test_release_info_updater.py mitreattack/release_info.py
```

The GitHub release assets must exist before running the updater, so this step belongs after publishing and tagging [mitre/cti](https://github.com/mitre/cti) and [mitre-attack/attack-stix-data](https://github.com/mitre-attack/attack-stix-data).

## Notes

Expand Down