Skip to content

Gate deployment changes on a changelog entry, and pin what CI runs - #12

Merged
danielplohmann merged 1 commit into
familiary:mainfrom
r0ny123:release/modernize-release-workflow
Sep 23, 2026
Merged

danielplohmann merged 1 commit into
familiary:mainfrom
r0ny123:release/modernize-release-workflow

Conversation

@r0ny123

@r0ny123 r0ny123 commented Sep 12, 2026 •

Copy link
Copy Markdown
Collaborator

#11 adopted Keep a Changelog and gave this repository's own changes somewhere to go, and said why that mattered: the Dockerfile learning to install from pyproject.toml, entry_test.sh gaining pytest and the TUNING.md drift check had all landed without an entry. Nothing makes the next such change write one either.

This is one of six pull requests giving the MCRIT ecosystem one release process. This repository is a deployment rather than a package — no version, no tag, no index — so it takes only the part that applies: CHANGELOG.md is the single authoritative record, written when a change merges, and CI enforces that.

Changes

  • Changelog check: a pull request that changes what a deployment is built from — docker/, nginx/, config/, the compose files, .env or the helper scripts — has to touch CHANGELOG.md or carry the no-changelog label. Read-only token, no PR content executed, Dependabot exempt.
  • RELEASING.md: what a release is here (a merged bump of .env with a dated entry), how a bump is done step by step, and where this repository sits in the ecosystem's release order (smda → MCRIT → MCRITweb → docker-mcrit).
  • CI hardening: actions/checkout@v3 (a floating major, two majors behind) is pinned to the v7.0.1 commit SHA with persist-credentials: false, and the workflow runs with contents: read.
  • Dependabot watches the pinned actions weekly and the ubuntu:24.04 base images of both Dockerfiles monthly, so a base-image bump arrives as a reviewable change.

No change to the images, the compose files or the shipped config. Python 3.12 was already what the images run, which is the floor the rest of the ecosystem now shares.

Tests

actionlint and zizmor --persona=regular report no findings on the workflows. The build-test job itself is untouched apart from the pin.

What a maintainer has to configure once

  • The no-changelog label.

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.

This repository releases by moving the pins in .env and writing a dated
CHANGELOG.md entry, and since the Keep a Changelog adoption its own changes
have somewhere to go - but nothing made anyone write them down. A pull
request that changes what a deployment is built from now has to touch
CHANGELOG.md or carry the no-changelog label. RELEASING.md says how a bump
is done, what a release is here, and where this repository sits in the
ecosystem's release order.

CI pins actions/checkout to a commit SHA, drops the checkout's credentials
from the runner, and runs with a read-only token. Dependabot watches the
pinned actions and the Ubuntu base images of both Dockerfiles, so a base
image bump arrives as a reviewable change rather than as whatever the tag
resolved to on rebuild day.

@danielplohmann danielplohmann left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. The no-changelog label now exists, so the gate has its escape hatch from the moment this lands.

@danielplohmann
danielplohmann merged commit 8bea9e5 into familiary:main Sep 23, 2026
3 checks passed
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