Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AGENTS.md

## Hotfix Release Playbook

Current release behavior in this repo:
- Pushing a tag matching `vX.Y.Z` triggers `.github/workflows/release.yml`.
- That workflow creates/updates the GitHub Release and uploads platform binaries.
- It does **not** publish crates to crates.io.

### Steps (security hotfix)
1. Prepare release commit on `master`:
- Update `Cargo.toml` version (for example `0.11.1`).
- Update `CHANGELOG.md` from `Unreleased` to the new version/date.
2. Validate locally:
- `cargo test`
- `cargo test --manifest-path utf16-simd/Cargo.toml`
- `cargo publish --dry-run`
3. Publish crates to crates.io (manual, if needed):
- Publish `utf16-simd` first **only** if its version changed.
- `cargo publish --manifest-path utf16-simd/Cargo.toml`
- Then publish `evtx`:
- `cargo publish`
4. Create and push the tag:
- `git tag vX.Y.Z`
- `git push origin vX.Y.Z`
5. Verify release:
- Confirm crates.io shows the new versions.
- Confirm CI succeeded via GitHub CLI:
- `gh run list --workflow release.yml --limit 5`
- `gh run watch <run-id>`
- Confirm release artifacts exist:
- `gh release view vX.Y.Z`
22 changes: 11 additions & 11 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 0 additions & 17 deletions release.py

This file was deleted.

4 changes: 2 additions & 2 deletions utf16-simd/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.