You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
bulk/release-plan-rollout-22305485219camaraproject/CapabilitiesAndRuntimeRestrictions:bulk/release-plan-rollout-22305485219Copy head branch name to clipboard
bulk/release-plan-rollout-22305485219camaraproject/CapabilitiesAndRuntimeRestrictions:bulk/release-plan-rollout-22305485219Copy head branch name to clipboard
Add release-plan.yaml for automated release tracking
TL;DR: This PR adds release-plan.yaml for automated release tracking (replacing manual API Release Tracker pages on wiki).
Note: Adding release-plan.yaml is a prerequisite for the upcoming release automation process.
This PR does not yet enable the automated release workflow; onboarding will follow separately.
What is this?
The release-plan.yaml file declares your release plan for this repository and its APIs. It enables:
Automated release tracking (replacing manual API Release Tracker pages on wiki)
CI validation of release readiness
Automated release preparation (enabled during onboarding)
Pre-populated data
Contacts: from your CODEOWNERS file
APIs: an initial placeholder entry is provided (even if API definition files already exist)
👉 Please review and adjust if API-specific contacts differ from repository-wide codeowners.
Placeholder API entry (before your first release)
For repositories without prior releases, the generated release-plan.yaml contains a placeholder API entry.
If you already know the final API name(s), please replace the placeholder now.
If the API name is not decided yet (e.g. community discussion ongoing), you may keep the placeholder as long astarget_api_status: draft.
👉 Before planning a release (by setting target_release_type to a non-none value, see table below) or changing the API status above draft, you must replace the placeholder with the final API name(s).
What to do next
Option A: Merge as-is (if no release planned yet)
Keep target_release_type: none
Keep APIs at target_api_status: draft
You can update names and add additional API entries later (recommended as soon as API naming is settled)
Option B: Update before merging (if you already know your API name(s))
Replace placeholder-entry with your intended API name(s) (kebab-case, per Commonalities naming guidelines)
Keep target_api_status: draft unless you are ready to declare alpha or rc
Review main_contacts (pre-populated from CODEOWNERS)
When ready to release
Ensure API names in release-plan.yaml match your files in code/API_definitions/
Update target_api_status from draft to alpha or rc (depending on your release target)
Gentle reminder: this PR adds the release-plan.yaml configuration file as part of the release automation onboarding for CAMARA repositories (see ReleaseManagement#379). The file is purely additive and does not change any existing code or API definitions. A codeowner approval is needed to merge it. cc @gmuratk@lbertz02
Thanks for the reminder @hdamker ,
In the last CRR call on March 31, 2026, we discussed this PR and agreed to go with Option B and change the api-name. Action was taken to propose options prior to next meeting and update the release-plan.yaml before merging. This should take too long for us to decide, and merge the updated file.
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
automatedAutomated bulk operations from project-administration
3 participants
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
TL;DR: This PR adds
release-plan.yamlfor automated release tracking (replacing manual API Release Tracker pages on wiki).What is this?
The
release-plan.yamlfile declares your release plan for this repository and its APIs. It enables:Pre-populated data
👉 Please review and adjust if API-specific contacts differ from repository-wide codeowners.
Placeholder API entry (before your first release)
For repositories without prior releases, the generated
release-plan.yamlcontains a placeholder API entry.target_api_status: draft.👉 Before planning a release (by setting
target_release_typeto a non-nonevalue, see table below) or changing the API status abovedraft, you must replace the placeholder with the final API name(s).What to do next
Option A: Merge as-is (if no release planned yet)
target_release_type: nonetarget_api_status: draftOption B: Update before merging (if you already know your API name(s))
placeholder-entrywith your intended API name(s) (kebab-case, per Commonalities naming guidelines)target_api_status: draftunless you are ready to declarealphaorrcmain_contacts(pre-populated from CODEOWNERS)When ready to release
release-plan.yamlmatch your files incode/API_definitions/target_api_statusfromdrafttoalphaorrc(depending on your release target)target_release_type(e.g.pre-release-alpha)API status and release type meanings
target_api_status
draftalpharcpublictarget_release_type
nonepre-release-alphapre-release-rcpublic-releasemaintenance-releaseDocumentation
📖 Release Management Documentation
📖 The release-plan.yaml File
📖 Release Lifecycle
📖 API Versioning