Skip to content

[bulk] Add release-plan.yaml (2026-01-13-001)#6

Closed
hdamker-bot wants to merge 1 commit intomainfrom
bulk/release-plan-rollout-20968073665
Closed

[bulk] Add release-plan.yaml (2026-01-13-001)#6
hdamker-bot wants to merge 1 commit intomainfrom
bulk/release-plan-rollout-20968073665

Conversation

@hdamker-bot
Copy link
Contributor

Add release-plan.yaml for automated release tracking

This PR introduces release-plan.yaml — a metadata file that enables automated release tooling for your repository.

What is this?

The release-plan.yaml file declares your release intentions. It enables:

  • Automated Release Progress Tracker (visibility across CAMARA)
  • CI validation of release readiness
  • Automated release branch creation (coming soon)

Pre-populated data

  • Contacts: From your CODEOWNERS file

👉 Please review and adjust if API-specific contacts differ from repository-wide codeowners.

What to do now

Option A: Merge as-is (if you don't have an API name defined yet)

  • The file contains an example-api placeholder
  • target_release_type: none means "no release currently planned"
  • You can add API definitions freely — validation applies when preparing a release

Option B: Update before merging (recommended if you have an API name)

  1. Replace example-api with your intended API name (kebab-case, per Commonalities naming guidelines)
  2. Keep target_api_status: draft — the API definition file doesn't need to exist yet
  3. Review main_contacts — pre-populated from CODEOWNERS

The API name can still be changed before your first release if needed.

When ready to release

  1. Ensure API names in this file match your files in code/API_definitions/
  2. Update target_api_status from draft to alpha (or higher)
  3. Set target_release_type: pre-release-alpha

API status progression

Status Meaning
draft API declared, definition file not required yet
alpha API definition exists, ready for early feedback
rc Release candidate, feature-complete
public Public release

Documentation

📖 Full documentation (work in progress)
📖 Release Workflow and Metadata Specification
📖 API Versioning (in CAMARA API Design Guide)

@hdamker-bot hdamker-bot added the automated Automated bulk operations from project-administration label Jan 13, 2026
@hdamker-bot hdamker-bot added the automated Automated bulk operations from project-administration label Jan 13, 2026
@github-actions
Copy link

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.01s
✅ API spectral 1 0 1.48s
✅ REPOSITORY git_diff yes no 0.0s
✅ REPOSITORY secretlint yes no 0.62s
✅ YAML yamllint 1 0 0.41s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@hdamker
Copy link
Contributor

hdamker commented Jan 13, 2026

Test workflow run, closing

@hdamker hdamker closed this Jan 13, 2026
@jpengar jpengar deleted the bulk/release-plan-rollout-20968073665 branch February 24, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated Automated bulk operations from project-administration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants