README: document the workflow templates and the TagBot env: marker#129
Merged
Conversation
Add a "Workflow templates" section explaining what template/.github/workflows/ contains, with a specific call-out for the TagBot.yml marker `env: REGISTRY_TAGBOT_ACTION: "JuliaRegistries/TagBot"`: why it's there, and why an inline YAML comment can't be used (itpkgfmt strips YAML comments via YAML.jl's writer, see YAML.jl#245). Cross- references ITensorActions for the full technical explanation. Bump to v0.3.52. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #129 +/- ##
=======================================
Coverage 87.34% 87.34%
=======================================
Files 1 1
Lines 158 158
=======================================
Hits 138 138
Misses 20 20
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Summary
Add a "Workflow templates" section to the README explaining what
template/.github/workflows/is for and calling out theTagBot.ymlmarkerenv: REGISTRY_TAGBOT_ACTION: "JuliaRegistries/TagBot"so future readers don't remove it as dead code.The marker exists because the General registry's TagBotTriggers workflow runs
RegistryCI.TagBot.maybe_notify, which only treats TagBot as enabled on a package repo if the literal substringJuliaRegistries/TagBotappears in some file under.github/workflows/. After delegating to the reusable workflow at ITensorActions, the caller no longer contains that string, so the substring check fails. The unusedenv:variable carries the literal substring so the check passes.A YAML comment would be simpler, but ITensorFormatter (
itpkgfmt) strips comments when reformatting YAML — a consequence of writing through YAML.jl, whose writer does not preserve comments (tracked upstream at YAML.jl#245).ITensorActions's README carries the full technical explanation; this README cross-references it and adds a short "do not remove this
env:block" note.Source is
examples/README.jl(Literate.jl regeneratesREADME.md). Bumps to v0.3.52.Test plan
🤖 Generated with Claude Code