[TEST - DO NOT MERGE] Add release-plan.yaml (2026-01-13-001)#7
Closed
hdamker-bot wants to merge 1 commit intomainfrom
Closed
[TEST - DO NOT MERGE] Add release-plan.yaml (2026-01-13-001)#7hdamker-bot wants to merge 1 commit intomainfrom
hdamker-bot wants to merge 1 commit intomainfrom
Conversation
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports |
1 task
Contributor
|
will be replaced with new test PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.yamlfile declares your release intentions. It enables:Pre-populated data
👉 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)
example-apiplaceholdertarget_release_type: nonemeans "no release currently planned"Option B: Update before merging (recommended if you have an API name)
example-apiwith your intended API name (kebab-case, per Commonalities naming guidelines)target_api_status: draft— the API definition file doesn't need to exist yetmain_contacts— pre-populated from CODEOWNERSThe API name can still be changed before your first release if needed.
When ready to release
code/API_definitions/target_api_statusfromdrafttoalpha(or higher)target_release_type: pre-release-alphaAPI status progression
draftalpharcpublicDocumentation
📖 Full documentation (work in progress)
📖 Release Workflow and Metadata Specification
📖 API Versioning (in CAMARA API Design Guide)