Skip to content

docs: encourage resilient overlays #19856

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
Christopher Co (christopherco) merged 1 commit into from
Oct 31, 2026
Merged

docs: encourage resilient overlays #19856

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,4 @@ Run all commands from the repo root (where `azldev.toml` lives). If the terminal
4. **Don't edit generated output**: Build artifacts in `base/out/` and `base/build/` are generated (configured by `output-dir`, `log-dir`, `work-dir` in `base/project.toml`) — never edit them directly. Note: `prep-sources -o <dir>` writes to a user-specified directory, separate from these project output dirs.
5. **Mandatory testing**: Any change that affects a component's output (overlays, build config, spec edits, version bumps, new components) MUST be validated by building AND testing the resulting RPMs. A successful build alone is not sufficient — smoke-test in a mock chroot. Pure organizational changes (moving definitions between files, editing descriptions/comments) do not require rebuild. See `AGENTS.md` for the full testing protocol.
6. **New specs use autorelease**: For any spec we author ourselves (local specs), use `%autorelease` and `%autochangelog` rather than a static `Release:` with a hand-written `%changelog`. The default `release.calculation = "auto"` detects ordinary, unconditional `%autorelease` usage, so do not set it explicitly. Use `release = { calculation = "autorelease" }` only when auto-detection cannot identify the spec's autorelease behavior, such as when `%autorelease` is conditional.
7. **Keep overlays resilient to upstream changes**: Express the intended change with minimal dependence on unrelated source details. Avoid unnecessarily matching or reproducing surrounding formatting or content. Use enough context to target the change unambiguously, but no more than needed.
Loading