generated from camaraproject/Template_API_Repository
-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
enhancementNew feature or requestNew feature or requestrelease automationRelated to the implementation or introduction of new release automationRelated to the implementation or introduction of new release automation
Description
Problem description
API repositories that want to use the Release Automation need specific configuration (rulesets, caller workflow, CODEOWNERS adjustments, CHANGELOG directory structure). This setup needs to be documented so it can be applied consistently across all repositories.
Proposed solution
Create a repository setup guide (release_automation/docs/repository-setup.md) that documents:
- Repository rulesets: Branch protection for
release-snapshot/**branches with GitHub App bypass - Caller workflow:
.github/workflows/release-automation.ymlthat references the reusable workflow in tooling - CHANGELOG directory structure: Migration from single
CHANGELOG.mdtoCHANGELOG/directory with per-release files - Verification checklist: Steps to confirm a repository is correctly configured
Additional context
An initial version of repository-setup.md exists on the release-automation branch. It needs updating to reflect the GitHub App bypass approach and the consolidated single-ruleset design.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestrelease automationRelated to the implementation or introduction of new release automationRelated to the implementation or introduction of new release automation