Skip to content

Repository navigation

Commit b46a9bf

Browse files
sebhmgCopilot
sebhmg
and
Copilot
committed
[DEVOPS-1249] document SHA pinning for callers and $/ for internal references
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent ed3ec7a commit b46a9bf

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,14 @@ jobs:
2222
uses: MiraGeoscience/CI-tools/<path_to_the_reusable_workflows>
2323
# e.g.: uses: MiraGeoscience/CI-tools/.github/workflows/reusable-jira-issue_to_jira.yml
2424
```
25+
26+
Pin `uses:` to a full commit SHA of CI-tools in calling repositories (Dependabot keeps it up to
27+
date).
28+
29+
## Referencing CI-tools from within CI-tools
30+
31+
Reusable workflows and actions of this repository reference each other with the self-repository
32+
syntax, for example `uses: $/.github/actions/setup-zizmor-config`. `$/` resolves to CI-tools at the
33+
exact commit that is running, so a caller pinned to a commit SHA runs every nested workflow and
34+
action from that same commit, and internal references never need a SHA or tag update.
35+
Do not use `MiraGeoscience/CI-tools/...@<ref>` for internal references.

0 commit comments

Comments
 (0)