Skip to content

Release on a tag from the changelog, with the checks that were memory before - #15

Merged
danielplohmann merged 2 commits into
familiary:mainfrom
r0ny123:release/modernize-release-workflow
Sep 16, 2026
Merged

danielplohmann merged 2 commits into
familiary:mainfrom
r0ny123:release/modernize-release-workflow

Conversation

@r0ny123

@r0ny123 r0ny123 commented Sep 12, 2026 •

Copy link
Copy Markdown
Collaborator

#17 is stacked on this PR. The multi-backend branch contains this commit and moves the release process into the new layout: ida-vX.Y.Z tags, ida-release.yml, the guard reading mcrit_plugin/ida/, and the changelog check on the new paths. It also has the Binary Ninja counterparts. Please merge this one first, then #17. With a merge commit #17 needs nothing; if this gets squashed or rebase-merged, #17 needs one git rebase --onto main ecfbb77 (this PR's commit after its rebase onto current main).

Heads-up: build-offline-dependencies.yml listens for release: published, and a release created with GITHUB_TOKEN never triggers that, which is why 1.1.7–1.1.9 have no wheelhouse bundles. It's fixed in #17, where the release workflow calls it directly.

The release history lives in the README, the tag workflow creates the GitHub release with generated notes only, and nothing checks that the tag names the version ida-plugin.json and config.py declare — verify_metadata_sync.py checks the three copies agree with each other, but a v1.2.0 tag on a tree that says 1.1.9 releases fine, under the wrong name.

This is one of six pull requests giving the MCRIT ecosystem one release process — the same guard, the same tag-triggered workflow, the same changelog check, and a RELEASING.md in each repository stating only the values that differ. A maintainer learns it once.

Changelog

The README "Version History" (11 releases) moves verbatim into CHANGELOG.md under ## Older releases, below a Keep a Changelog ## [Unreleased] section; the README links to it. verify_metadata_sync.py reads the newest release heading from CHANGELOG.md instead of the README, accepting both the Keep a Changelog form and the carried-over ### vX.Y.Z (date) form. Every PR that touches helpers/, widgets/, icons/, ida_mcrit.py, config.py or ida-plugin.json adds its own bullet or carries the no-changelog label; a new Changelog check enforces that (read-only token, no PR content executed).

What pushing vX.Y.Z does now

.github/workflows/release.yml:

job what it does
verify refuses unless the tag matches ida-plugin.json and config.py, CHANGELOG.md has a ## [X.Y.Z] - <date> section (written out as the notes), the commit is an ancestor of main, and the pytest workflow concluded success on that commit
build the existing steps — verify_metadata_sync.py --expected-version, verify_settings_sync.py, run_quality_checks.py, package_plugin.py, hcli plugin lint on the tree and the ZIP
release gh release create with the changelog section as body, --generate-notes appended, mcrit-ida-<version>.zip attached. Pre-release tags are marked --prerelease and not --latest

softprops/action-gh-release is replaced by the runner's own gh in this workflow: one fewer third party in the path that signs and announces a release. The Build Offline Dependencies workflow still runs from the published release, as before. The guard script has tests (tests/test_release_guard.py).

Security

  • build-offline-dependencies.yml expanded github.event.release.tag_name directly inside PowerShell scripts in a job with contents: write — a tag name is attacker-influenced text. The values now reach the scripts through env. The checkout there no longer keeps its credentials on the runner. This was the one zizmor error in the repository; the remaining informational findings are in ida-tests.yml, which is manual-dispatch only and out of scope here.
  • ruff.yml gains permissions: contents: read and persist-credentials: false; the new workflows follow the same pattern.
  • A dependabot.yml keeps the SHA-pinned actions current.
  • zizmor --persona=regular on the workflows touched here: no findings; actionlint clean.

Python

CI and the release workflow run on Python 3.12, and ruff's target-version moves from py38 (which AGENTS.md said was for formatting only) to py312. The ecosystem shares a 3.12 floor now; smda, which the plugin needs in IDA's interpreter, requires 3.12 from its next release, and IDA 9 bundles 3.12. Nothing in the plugin needed it.

Tests

  • 93 passed (82 before, plus the guard tests) with pytest; ruff check and ruff format --check clean.
  • verify_metadata_sync.py --expected-version 1.1.9, verify_settings_sync.py and run_quality_checks.py pass on the tree; package_plugin.py builds the ZIP and hcli plugin lint (0.23.0) passes on both the tree and the ZIP.

What a maintainer has to configure once

  • The no-changelog label. Nothing else.

Compatibility

The plugin ZIP, its contents and the HCLI metadata are unchanged. The next release will be the first with a ## [X.Y.Z] - <date> section; until then a tag push fails at the guard with a message saying so.

Related pull requests across the ecosystem

The same process, one PR per repository. None depends on another to merge; release order once merged is smda → purepdb → picblocks → MCRIT → MCRITweb → docker-mcrit.

… before

The release history lived in the README, the tag workflow created the GitHub
release with generated notes only, and nothing checked that the tag named the
version ida-plugin.json and config.py declare.

The history moves into CHANGELOG.md unchanged, with a Keep a Changelog section
above it; verify_metadata_sync.py reads the newest heading from there. Pushing
a vX.Y.Z tag now refuses to continue unless the tag matches both version
strings, the version has a changelog section, the commit is on main and CI
passed on it; then runs the metadata, settings and quality checks, builds the
plugin archive, lints it with hcli, and creates the GitHub release from the
changelog section with the archive attached, through gh rather than a
third-party action. Pre-release tags are marked as such.

A PR that changes shipped plugin files has to touch CHANGELOG.md or carry the
no-changelog label. Dependabot keeps the SHA-pinned actions current. CI runs
on Python 3.12, the floor shared across the MCRIT ecosystem.
@r0ny123
r0ny123 force-pushed the release/modernize-release-workflow branch from b7b1cfd to ecfbb77 Compare September 16, 2026 07:56
This branch moves the release history out of README.md and points
verify_metadata_sync.py at CHANGELOG.md. The rebase onto main brought
config.py and ida-plugin.json to 1.1.10, but 1.1.10's entry was written in
README.md, which this branch deletes, so the newest changelog heading stayed
at v1.1.9 and validate failed:

  Version mismatch: config.py VERSION does not match latest CHANGELOG.md
  release heading.

Carries over the section already written on familiary#17, verbatim, so the two
branches do not diverge, and updates the compare links to match.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@danielplohmann

Copy link
Copy Markdown
Collaborator

Pushed 21b0530 to this branch (thanks for leaving maintainer edits on) - validate was failing after the rebase.

This branch moves the release history out of README.md and points verify_metadata_sync.py at CHANGELOG.md. The rebase brought config.py and ida-plugin.json to 1.1.10, but 1.1.10's entry was written into README.md, which this branch deletes, so the newest changelog heading stayed at v1.1.9:

Version mismatch: config.py VERSION does not match latest CHANGELOG.md release heading.
Version mismatch: ida-plugin.json plugin.version does not match latest CHANGELOG.md release heading.

That's our doing, not yours - we released 1.1.10 straight to main while this was in flight, and the README is exactly the file the two changes disagree about.

The commit carries over the ## [1.1.10] - 2026-09-16 section you already wrote on #17, verbatim, plus the compare-link update, so the two branches don't diverge. Locally: verify_metadata_sync.py --expected-version 1.1.10, verify_settings_sync.py, 97 pytest, ruff check and ruff format --check all pass.

Nice catch on the missing HCLI_API_KEY on the fork side - that the head-repo gate passes there while the job then dies inside hcli is the half I didn't see. The preflight plus if: always() result job is the right shape.

One thing that's ours to do before this merges: the no-changelog label doesn't exist in the repository yet, so changelog.yml has nothing to match on. We'll create it.

@danielplohmann
danielplohmann merged commit 3255e29 into familiary:main Sep 16, 2026
5 checks passed
@r0ny123
r0ny123 deleted the release/modernize-release-workflow branch September 30, 2026 18:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants