Skip to content

Commit 9d23e70

Browse files
authored
Update copilot-instructions with versioning guidelines (#1177)
1 parent 740be64 commit 9d23e70

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

.github/copilot-instructions.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ This repository contains shared/reusable CI configurations for GitHub Actions se
1717
echo "v9.1.0" > version.txt
1818
```
1919

20+
When referencing internal actions in workflow YAML files, **always use the latest released tag** (e.g., `v9.2.0`).
21+
Do **not** update these references to the next release version (e.g., `v9.3.0`) **in a pull request that is bumping the version** in `version.txt`.
22+
This is because the new tag (e.g., `v9.3.0`) will only be created and pushed at the end of the release build process.
23+
If you update the reference before the tag exists, the master build will fail after merging, as the referenced tag does not yet exist.
24+
2025
### Documentation Requirements
2126

2227
**Always update `docs/README.md`** when adding or modifying GitHub Actions:
@@ -136,6 +141,7 @@ pre-commit run --all-files
136141

137142
- Releases are triggered automatically when PRs are merged to master
138143
- The version in `version.txt` determines the release tag
144+
- Actions will automatically be updated with the release tag by the release workflow itself, no need to do it manually
139145
- Release notes are auto-generated from PR titles and descriptions
140146
- The `release.sh` script automatically updates all internal version references that use version tags
141147
- **CRITICAL**: Internal references must use version tags (not SHA pins) for automatic updates to work

0 commit comments

Comments
 (0)