Skip to content

Commit a4638f8

Browse files
huaweic-nvclaude
andcommitted
docs: add actions-ref limitation comment to reusable workflows
Explain why actions-ref input must match the caller's @ref — GitHub Actions does not expose the called ref to reusable workflows, and relative paths (./) resolve to the caller's repo context. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Hua-Wei Chen <huaweic@nvidia.com>
1 parent 1979317 commit a4638f8

2 files changed

Lines changed: 22 additions & 2 deletions

File tree

.github/workflows/dsx-ci-go.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,17 @@
1313
# limitations under the License.
1414

1515
# Reusable CI workflow for DSX Go projects.
16-
# Each job checks out the caller's repo + dsx-github-actions at the same
17-
# ref used by the caller, so pinning the workflow ref pins all actions.
16+
#
17+
# IMPORTANT: actions-ref must match the ref used to call this workflow.
18+
# GitHub Actions does not provide a way for reusable workflows to know
19+
# which ref they were called with -- uses: requires a static string and
20+
# relative paths (./) resolve to the caller's repo, not this one.
21+
# This is a known GitHub Actions platform limitation.
22+
#
23+
# Example:
24+
# uses: NVIDIA/dsx-github-actions/.github/workflows/dsx-ci-go.yml@v1.15.0
25+
# with:
26+
# actions-ref: v1.15.0 # must match the @ref above
1827

1928
name: DSX Go CI
2029

.github/workflows/dsx-ci-helm.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,17 @@
1313
# limitations under the License.
1414

1515
# Reusable CI workflow for DSX Helm chart projects.
16+
#
17+
# IMPORTANT: actions-ref must match the ref used to call this workflow.
18+
# GitHub Actions does not provide a way for reusable workflows to know
19+
# which ref they were called with -- uses: requires a static string and
20+
# relative paths (./) resolve to the caller's repo, not this one.
21+
# This is a known GitHub Actions platform limitation.
22+
#
23+
# Example:
24+
# uses: NVIDIA/dsx-github-actions/.github/workflows/dsx-ci-helm.yml@v1.15.0
25+
# with:
26+
# actions-ref: v1.15.0 # must match the @ref above
1627

1728
name: DSX Helm CI
1829

0 commit comments

Comments
 (0)