ci(check-ready): let the template itself cut version-marker releases - #37
Merged
Merged
Conversation
The release-path workflows (Zenodo / Software Heritage / Wayback / Docker) guard on check-ready, which hard-fails a release event while the .template-uninitialised sentinel is present. That is correct for a scaffolded replication, but it also blocks the canonical template repo from cutting its own version-marker GitHub Release (e.g. to mark v2.1.0), since the template is permanently uninitialised by design. Use GitHub's is_template flag (true only on the canonical template; false on any repo created from it) to skip the archival pipeline green on the template's own release, while still hard-failing a release of a genuinely unready replication. Verified across all four scenarios.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The archival workflows (Zenodo / Software Heritage / Wayback / Docker) guard on
check-ready, which hard-fails areleaseevent while.template-uninitialisedis present. That correctly blocks releasing an un-initialised replication, but it also blocks the canonical template repo from cutting its own version-marker GitHub Release — the template is permanently uninitialised by design, so a Release currently produces four failed archival runs.Fix: use GitHub's
is_templateflag (true only on the canonical template; false on any repo created from it via Use this template) to skip the archival pipeline green on the template's own release, while still hard-failing a release of a genuinely unready replication.Verified locally (YAML valid + all four scenarios):
is_template=true→ skip green ✅is_template=false→ fail (exit 1) ✅ (guard preserved)ready=true✅After this merges, a GitHub Release can be cut on the template (e.g. to give v2.1.0 a visible Releases entry) without the archival jobs failing.