molecule-ai/molecule-ci
34
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: pin reusable-workflow examples from @main to @v1 (P133)

Browse Source 
The v1 tag exists in this repo but README + docs still showed
@main in the caller-pattern examples. Followers of the docs were
copy-pasting unstable @main pins. Fix: update all 6 example
references to @v1 across:

- README.md (4 examples)
- docs/template-contract.md (1 example)
- .github/workflows/auto-promote-staging-pr.yml header comment
  (1 example, just shipped in PR #25)

Operational note: v1 is meant to track the latest stable patch
within the v1 major. Cutting a new v1.X.Y or breaking-change v2
requires moving the v1 tag forward — same convention as
actions/checkout@v4 etc.

Doesn't migrate any consumer repo. Consumer migration from @main
to @v1 is a per-repo follow-up; this PR ships the docs that
guide that migration.

Closes task #133.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Hongming Wang 2026-04-30 01:04:06 -07:00
parent 6afeb47e5e
commit 8f041a9485
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/auto-promote-staging-pr.yml vendored
View File

@ -28,7 +28,7 @@ name: Auto-promote staging → main (PR-based, reusable)
# pull-requests: write # pull-requests: write
# jobs: # jobs:
# promote: # promote:
# uses: Molecule-AI/molecule-ci/.github/workflows/auto-promote-staging-pr.yml@main # uses: Molecule-AI/molecule-ci/.github/workflows/auto-promote-staging-pr.yml@v1
# with: # with:
# gates: "ci.yml,e2e-staging-canvas.yml,e2e-api.yml,codeql.yml" # gates: "ci.yml,e2e-staging-canvas.yml,e2e-api.yml,codeql.yml"
# force: ${{ github.event.inputs.force == 'true' }} # force: ${{ github.event.inputs.force == 'true' }}

8
README.md
View File

@ -12,7 +12,7 @@ name: CI
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
validate: validate:
uses: Molecule-AI/molecule-ci/.github/workflows/validate-plugin.yml@main uses: Molecule-AI/molecule-ci/.github/workflows/validate-plugin.yml@v1
``` ```
### Workspace template repos (`molecule-ai-workspace-template-*`) ### Workspace template repos (`molecule-ai-workspace-template-*`)
@ -23,7 +23,7 @@ name: CI
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
validate: validate:
uses: Molecule-AI/molecule-ci/.github/workflows/validate-workspace-template.yml@main uses: Molecule-AI/molecule-ci/.github/workflows/validate-workspace-template.yml@v1
``` ```
### Org template repos (`molecule-ai-org-template-*`) ### Org template repos (`molecule-ai-org-template-*`)
@ -34,7 +34,7 @@ name: CI
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
validate: validate:
uses: Molecule-AI/molecule-ci/.github/workflows/validate-org-template.yml@main uses: Molecule-AI/molecule-ci/.github/workflows/validate-org-template.yml@v1
``` ```
### Any repo with auto-merge enabled ### Any repo with auto-merge enabled
@ -51,7 +51,7 @@ permissions:
pull-requests: write pull-requests: write
jobs: jobs:
disable-auto-merge-on-push: disable-auto-merge-on-push:
uses: Molecule-AI/molecule-ci/.github/workflows/disable-auto-merge-on-push.yml@main uses: Molecule-AI/molecule-ci/.github/workflows/disable-auto-merge-on-push.yml@v1
``` ```
When the team lands more PR-time guards in this repo, add them as additional jobs in the same caller — keeps each consuming repo's footprint to one file. When the team lands more PR-time guards in this repo, add them as additional jobs in the same caller — keeps each consuming repo's footprint to one file.

2
docs/template-contract.md
View File

@ -54,7 +54,7 @@ name: CI
on: [push, pull_request] on: [push, pull_request]
jobs: jobs:
validate: validate:
uses: Molecule-AI/molecule-ci/.github/workflows/validate-workspace-template.yml@main uses: Molecule-AI/molecule-ci/.github/workflows/validate-workspace-template.yml@v1
``` ```
The reusable workflow checks out `molecule-ci` itself (into `.molecule-ci-canonical`) and runs the canonical `validate-workspace-template.py` from there — so no per-repo vendoring of the script is needed. The legacy `.molecule-ci/scripts/` directory in each template repo is being phased out. The reusable workflow checks out `molecule-ci` itself (into `.molecule-ci-canonical`) and runs the canonical `validate-workspace-template.py` from there — so no per-repo vendoring of the script is needed. The legacy `.molecule-ci/scripts/` directory in each template repo is being phased out.