Skip to content

Update copilot-instructions with versioning guidelines #1177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 6, 2025
+6 −0
Merged

Update copilot-instructions with versioning guidelines #1177

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac11cf6
Update copilot-instructions with versioning guidelines
gionn Oct 6, 2025
5d1c3db
fixup
gionn Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ This repository contains shared/reusable CI configurations for GitHub Actions se
echo "v9.1.0" > version.txt
```

When referencing internal actions in workflow YAML files, **always use the latest released tag** (e.g., `v9.2.0`).
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`.
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.
If you update the reference before the tag exists, the master build will fail after merging, as the referenced tag does not yet exist.

### Documentation Requirements

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

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