Commit dca0d58
README: document the workflow templates and the TagBot
## Summary
Add a "Workflow templates" section to the README explaining what
`template/.github/workflows/` is for and calling out the `TagBot.yml`
marker `env: 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](https://github.com/JuliaRegistries/General/blob/master/.github/workflows/TagBotTriggers.yml)
runs `RegistryCI.TagBot.maybe_notify`, which only treats TagBot as
enabled on a package repo if the literal substring
`JuliaRegistries/TagBot` appears in some file under
`.github/workflows/`. After delegating to the reusable workflow at
[ITensorActions](https://github.com/ITensor/ITensorActions), the caller
no longer contains that string, so the substring check fails. The unused
`env:` variable carries the literal substring so the check passes.
A YAML comment would be simpler, but
[ITensorFormatter](https://github.com/ITensor/ITensorFormatter.jl)
(`itpkgfmt`) strips comments when reformatting YAML — a consequence of
writing through [YAML.jl](https://github.com/JuliaData/YAML.jl), whose
writer does not preserve comments (tracked upstream at
[YAML.jl#245](JuliaData/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 regenerates `README.md`).
Bumps to v0.3.52.
## Test plan
- [x] No code changes; documentation only.
- [x] Pre-commit checks pass (yaml/toml/EOL/ITensor formatter).
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>env: marker (#129)1 parent ced1588 commit dca0d58
3 files changed
Lines changed: 41 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
51 | 71 | | |
52 | 72 | | |
53 | 73 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
0 commit comments