docs(instructions): document autorelease convention for locally-authored specs#17933
Open
WithEnoughCoffee wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a single new item (rule #6) to the Repository Hygiene Rules section of .github/copilot-instructions.md, documenting the team convention that locally-authored specs should use rpmautospec's %autorelease/%autochangelog macros with release = { calculation = "autorelease" } rather than a static Release: and hand-written %changelog. It is a docs-only change with no build impact, split out from the telegraf PR (#17798) so the convention can be reviewed independently.
I verified the technical claims:
"autorelease"is a valid value forrelease.calculation(enum inexternal/schemas/azldev.schema.json:835-840) and is already used in-tree (e.g.base/comps/samba/samba.comp.toml:3,base/comps/gvisor-tap-vsock/gvisor-tap-vsock.comp.toml:5).%autorelease/%autochangelogare the correct rpmautospec macro names and appear across rendered specs.- The new bullet's formatting (bold prefix + colon) matches the surrounding rules 1–5.
Changes:
- Add hygiene rule #6 instructing that self-authored/local specs use
%autorelease/%autochangelogand setrelease = { calculation = "autorelease" }.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new Repository Hygiene Rule to
.github/copilot-instructions.mddocumenting the team convention that locally-authored specs should use%autorelease/%autochangelograther than a staticRelease:with a hand-written%changelog.This was originally proposed as part of the telegraf PR (#17798), but per review feedback from @tobiasb-ms it was split out into its own PR so the convention change is reviewed independently of the telegraf packaging work.
Change
Item 6 under Repository Hygiene Rules:
Docs-only change; no build impact.