Skip to content

feat(release-automation): add API comparison baselines to release review - #336

Merged
hdamker merged 4 commits into
camaraproject:mainfrom
hdamker:feat/auto-comparison-baseline-rm568
Jun 17, 2026
Merged

feat(release-automation): add API comparison baselines to release review#336
hdamker merged 4 commits into
camaraproject:mainfrom
hdamker:feat/auto-comparison-baseline-rm568

Conversation

@hdamker

@hdamker hdamker commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

feat(release-automation): add API comparison baselines to release review

What type of PR is this?

enhancement/feature

What this PR does / why we need it:

Adds per-API comparison baselines to the release automation output.

  • The snapshot creator reuses the existing CHANGELOG comparison-base rule for the release type.
  • It reads that comparison tag's release-metadata.yaml through GitHubClient.get_release_metadata.
  • Matching apis[].api_version values are rendered in generated CHANGELOG API sections and in the Release Review PR Changes compared to column.
  • APIs without a matching previous entry omit the CHANGELOG comparison sentence and show N/A in the PR table.

Which issue(s) this PR fixes:

Implements camaraproject/ReleaseManagement#568 (close manually after merge).

Special notes for reviewers:

This does not change the release-metadata.yaml schema. The baseline is derived while generating the snapshot review context.

Changelog input

release-note
Release automation now states each API's comparison baseline in generated CHANGELOG sections and the Release Review PR table when a matching previous API version exists.

Additional documentation

No additional documentation.

docs

@hdamker
hdamker requested review from Kevsy and rartych as code owners June 14, 2026 10:45
Kevsy
Kevsy previously approved these changes Jun 15, 2026

@Kevsy Kevsy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hdamker
hdamker requested a review from tanjadegroot June 15, 2026 19:58
Comment thread release_automation/templates/pr_bodies/release_review_pr.mustache

| API | Version | Status |
|-----|---------|--------|
| API | Version | Status | Changes to be compared to |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| API | Version | Status | Changes to be compared to |
| API | Version | Status | Changes compared to |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a tension between "already compared" and "to be compared". To avoid that I will change it to "Comparison target" ... that fits also to the text below in the instructions.

Done in 821f4a2 (including the tests)

Comment thread release_automation/tests/test_template_loader.py Outdated
Comment thread release_automation/tests/test_template_loader.py Outdated

@tanjadegroot tanjadegroot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, one small change but this seems already to be done in the TestRepo-QoD Release review PR

@hdamker

hdamker commented Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Looks good to me, one small change but this seems already to be done in the TestRepo-QoD Release review PR

@tanjadegroot see the changes in 821f4a2 and reply above.

Merge main: Add PR-time validation and release checks

@tanjadegroot tanjadegroot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect

/LGTM

@rartych rartych left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@hdamker
hdamker merged commit f57e127 into camaraproject:main Jun 17, 2026
8 checks passed
@hdamker
hdamker deleted the feat/auto-comparison-baseline-rm568 branch June 17, 2026 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

State the previous API version that release-note changes are compared against

4 participants