Skip to content

README: document the workflow templates and the TagBot env: marker #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mtfishman merged 1 commit into from
Apr 27, 2026
Merged

README: document the workflow templates and the TagBot env: marker #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name = "ITensorPkgSkeleton"
uuid = "3d388ab1-018a-49f4-ae50-18094d5f71ea"
version = "0.3.51"
version = "0.3.52"
authors = ["ITensor developers <support@itensor.org> and contributors"]

[workspace]
Expand Down
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,26 @@ ITensorPkgSkeleton.generate("MyPackage")

Examples go here.

## Workflow templates

The `template/.github/workflows/` directory is the source of truth for the GitHub Actions
workflows shared across the ITensor ecosystem (`Tests.yml`, `FormatCheck.yml`, `TagBot.yml`,
`CompatHelper.yml`, etc.). Most of them simply call into reusable workflows in
[ITensorActions](https://github.com/ITensor/ITensorActions); see that repository's README
for details on each.

`TagBot.yml` carries a marker `env: REGISTRY_TAGBOT_ACTION: "JuliaRegistries/TagBot"`
that looks unused but is required: the General registry's trigger workflow only treats
TagBot as enabled when the literal string `JuliaRegistries/TagBot` appears in a file
under `.github/workflows/`, and the reusable-workflow caller would otherwise not
contain it. The same string would work as a YAML comment, but
[ITensorFormatter](https://github.com/ITensor/ITensorFormatter.jl) (`itpkgfmt`) strips
YAML comments via [YAML.jl](https://github.com/JuliaData/YAML.jl)'s writer (tracked
upstream at [YAML.jl#245](https://github.com/JuliaData/YAML.jl/issues/245)), so the
marker has to live in a structural element. See
[ITensorActions's TagBot docs](https://github.com/ITensor/ITensorActions#why-the-env-marker)
for the full explanation. Do not remove this `env:` block.

---

*This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*
Expand Down
20 changes: 20 additions & 0 deletions examples/README.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,23 @@ julia> Pkg.add("ITensorPkgSkeleton")
using ITensorPkgSkeleton: ITensorPkgSkeleton
ITensorPkgSkeleton.generate("MyPackage")
# Examples go here.

# ## Workflow templates
#
# The `template/.github/workflows/` directory is the source of truth for the GitHub Actions
# workflows shared across the ITensor ecosystem (`Tests.yml`, `FormatCheck.yml`, `TagBot.yml`,
# `CompatHelper.yml`, etc.). Most of them simply call into reusable workflows in
# [ITensorActions](https://github.com/ITensor/ITensorActions); see that repository's README
# for details on each.
#
# `TagBot.yml` carries a marker `env: REGISTRY_TAGBOT_ACTION: "JuliaRegistries/TagBot"`
# that looks unused but is required: the General registry's trigger workflow only treats
# TagBot as enabled when the literal string `JuliaRegistries/TagBot` appears in a file
# under `.github/workflows/`, and the reusable-workflow caller would otherwise not
# contain it. The same string would work as a YAML comment, but
# [ITensorFormatter](https://github.com/ITensor/ITensorFormatter.jl) (`itpkgfmt`) strips
# YAML comments via [YAML.jl](https://github.com/JuliaData/YAML.jl)'s writer (tracked
# upstream at [YAML.jl#245](https://github.com/JuliaData/YAML.jl/issues/245)), so the
# marker has to live in a structural element. See
# [ITensorActions's TagBot docs](https://github.com/ITensor/ITensorActions#why-the-env-marker)
# for the full explanation. Do not remove this `env:` block.
Loading