Skip to content

[bulk] Add release-plan.yaml (2026-02-23-001)#17

Merged
abd-abhisek merged 7 commits intomainfrom
bulk/release-plan-rollout-22305485219
Mar 2, 2026
Merged

[bulk] Add release-plan.yaml (2026-02-23-001)#17
abd-abhisek merged 7 commits intomainfrom
bulk/release-plan-rollout-22305485219

Conversation

@hdamker-bot
Copy link
Contributor

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 as target_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))

  1. Replace placeholder-entry with your intended API name(s) (kebab-case, per Commonalities naming guidelines)
  2. Keep target_api_status: draft unless you are ready to declare alpha or rc
  3. Review main_contacts (pre-populated from CODEOWNERS)

When ready to release

  1. Ensure API names in release-plan.yaml match your files in code/API_definitions/
  2. Update target_api_status from draft to alpha or rc (depending on your release target)
  3. Set target_release_type (e.g. pre-release-alpha)
API status and release type meanings

target_api_status

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

target_release_type

Value When to use
none No release currently planned
pre-release-alpha Early, incomplete preview release for feedback
pre-release-rc Release candidate publication
public-release Public CAMARA release
maintenance-release Patch/maintenance release in an existing cycle

Documentation

📖 Release Management Documentation
📖 The release-plan.yaml File
📖 Release Lifecycle
📖 API Versioning

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

github-actions bot commented Feb 23, 2026

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.01s
✅ API spectral 1 0 1.95s
✅ GHERKIN gherkin-lint 5 0 1.72s
✅ REPOSITORY git_diff yes no 0.0s
✅ REPOSITORY secretlint yes no 0.73s
✅ YAML yamllint 1 0 0.5s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@hdamker
Copy link
Contributor

hdamker commented Feb 26, 2026

@hemantagogoi-infy we had a discussion when creating the repository about multipoint vs multi-pointand the team decided for multi-point. So the api-name should be multi-point-vpn (to be aligned with the repository name MultiPointVPN).

Hint: keep target_release_type on none and the target_api_status on draft, then you can merge, align the API definition file (both within and the filename), and update the release-plan.yaml later when the Release Automation is available to declare the actual target.

Changed target release type to 'none' and updated API name and status.
@hemantagogoi-infy
Copy link
Contributor

@hemantagogoi-infy we had a discussion when creating the repository about multipoint vs multi-pointand the team decided for multi-point. So the api-name should be multi-point-vpn (to be aligned with the repository name MultiPointVPN).

Hint: keep target_release_type on none and the target_api_status on draft, then you can merge, align the API definition file (both within and the filename), and update the release-plan.yaml later when the Release Automation is available to declare the actual target.

Thank you for pointing out, I will follow up and update accordingly.

@abd-abhisek abd-abhisek merged commit e8bfab9 into main Mar 2, 2026
2 checks passed
@abd-abhisek abd-abhisek deleted the bulk/release-plan-rollout-22305485219 branch March 2, 2026 10:41
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.

4 participants