Repository navigation
docs: add AGENTS.md — reusable-workflow blast radius and tag discipline - #15
vernonstinebaker wants to merge 2 commits into
Conversation
DonPrus
left a comment
There was a problem hiding this comment.
The organization-wide impact deserves documentation, but the operational instructions need correction before approval.
-
v1is currently a branch, not a version tag.git ls-remote origin refs/heads/v1 refs/tags/v1returns onlyrefs/heads/v1(2b9c2f2...), and the tags/v1 REST lookup returns 404. The repeated instructions to move a published tag therefore describe a different release mechanism. It would be great to document the actual promotion procedure for the existing v1 branch and distinguish a moving version ref from a commit pin. Creating a same-named tag is not a harmless substitute: GitHub gives tags precedence over branches with the same name. -
There is no YAML lint gate in the current CI.
.github/workflows/ci.ymlinstalls Zig and testsnightly_decide.zigandpackage_artifact.zig; it runs neither actionlint nor a YAML linter. Please replace the validation claim with the actual checks and an explicit workflow-validation command/process rather than implying that a green helper-test job validates the reusable workflows. -
zig_versionis not pinned by every consumer: nullclaw and nullboiler omit it and inherit the shared default, while nullhub explicitly passes 0.16.0. It would be useful to state this distinction when describing the impact of default-version changes.
I checked the full diff, existing README, all repository workflows, live v1 ref and representative consumer configurations. The PR merges cleanly, but withholding approval because this file directs future agents' publication and validation behavior.
…actual CI checks; note zig_version pinning is inconsistent (DonPrus review)
|
All three corrections addressed in b0b6798. Each verified against the live repo before editing: 1. Added the promotion procedure you asked for — land/validate on 2. YAML lint claim replaced with what CI actually does. The doc now lists the real 3. Validation — merge result
Ready for re-review. |
NullBuilder hosts the reusable CI workflows every null-stack repo pins (zig-ci.yml@v1 et al.), but had no agent/contributor guidance. Added a thin AGENTS.md documenting the org-wide blast radius: consumer repos pin version tags, so workflow changes follow main-first → validate on a consumer → then move the tag; toolchain bumps must be coordinated with consumer docs; dependabot action bumps affect all consumers. Docs-only.