Skip to content

Define API repository setup for Release Automation #71

@hdamker

Description

@hdamker

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:

  1. Repository rulesets: Branch protection for release-snapshot/** branches with GitHub App bypass
  2. Caller workflow: .github/workflows/release-automation.yml that references the reusable workflow in tooling
  3. CHANGELOG directory structure: Migration from single CHANGELOG.md to CHANGELOG/ directory with per-release files
  4. 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.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestrelease automationRelated to the implementation or introduction of new release automation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions