Update repository-setup.md for single ruleset design#75
Update repository-setup.md for single ruleset design#75hdamker wants to merge 4 commits intocamaraproject:release-automationfrom
Conversation
…ject#71) Consolidate 3 rulesets into 1 combined release-snapshot-protection ruleset with GitHub App bypass, 2 required approvals, and required_reviewers for the release-management_reviewers team. Update CODEOWNERS guidance to reflect removal of legacy /CHANGELOG.md lines. Update verification checklist.
|
@tanjadegroot @Kevsy @rartych @albertoramosmonagas this documentation of the needed setup within an API Repository for the Release Automation is worth a review (the resulting file, not the changes). Note: The setup will be done by the campaign and script described in camaraproject/project-administration#132 camaraproject/project-administration#133 (and for new repositories via the Template_API_Repository). ReleaseTest repo to come. |
There was a problem hiding this comment.
'four-eyes' is ambiguous - if taken the same way as 'five eyes' in national security terminology, it could be interpreted as meaning four people. If it means two distinct people, then I suggest:
| - Required approvals: 2 (enforces four-eyes review even if a person is in both codeowner and RM reviewer teams) | |
| - Required approvals: 2 (enforces two-person review in case a codeowner is also part of the RM reviewer team) |
There was a problem hiding this comment.
Replaced with:
- Required approvals: 2 (ensures two distinct people must approve, even if a person is in both codeowner and RM reviewer teams)
Replace ambiguous "four-eyes review" with explicit "two distinct people must approve" per PR review feedback.
Revert D-008: keep /CHANGELOG.md and /CHANGELOG.MD lines in CODEOWNERS to prevent unreviewed changes to the legacy changelog file during Phase 1 migration. RM reviewer assignment on snapshot branches is additionally enforced via ruleset required_reviewers.
Document 3-way CHANGELOG.md handling: unchanged template placeholders are deleted, repos with real content get forward-reference notes, and repos without CHANGELOG.md get a fresh index. Update verification checklist accordingly.
|
One after review thought: who should apply/check the repo configuration and when ? |
What type of PR is this?
What this PR does / why we need it:
Updates
repository-setup.mdto reflect the consolidated ruleset design:release-snapshot-protectionrulesetcamara-release-automationGitHub Apprequired_reviewersfor therelease-management_reviewersteam with 2 required approvals/CHANGELOG.mdlines are removed by the onboarding campaign, RM reviewer enforcement moves to the rulesetThe canonical ruleset has been created manually in
Template_API_Repository(ID: 12904446) and this document matches it exactly.Which issue(s) this PR fixes:
Fixes #71
Special notes for reviewers:
The JSON payload in the document was extracted from the actual ruleset in Template_API_Repository. The
required_reviewersfield is a beta feature in the GitHub Rulesets API but is functional and available in the UI.Changelog input
Additional documentation
This section can be blank.