fix: Correct calculation of commits for changelog for release workflows by morri-son · Pull Request #1971 · open-component-model/open-component-model

morri-son · 2026-03-13T15:33:44Z

On-behalf-of: Gerald Morrison (SAP) gerald.morrison@sap.com

What this PR does / why we need it

Add new function to calculate the latest previous non-RC tag to determine the correct range of commits for the changelog.

Summary by CodeRabbit

Chores
- Improved release versioning to compute and expose the previous release tag and a concrete changelog range for release-candidate flows, pass that range into the changelog generator, and surface these values in step summaries and workflow outputs (first-release behavior preserved).
Tests
- Added comprehensive tests covering prior-release detection, RC and edge-case scenarios to ensure correct changelog-range behavior.

…mine the correct range of commits for the changelog. On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

coderabbitai · 2026-03-13T15:34:05Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 57899fc9-7b21-4f71-b1e4-dfb4879044f5

📥 Commits

Reviewing files that changed from the base of the PR and between 2029d54 and 3255551.

📒 Files selected for processing (2)

.github/scripts/release-versioning.js
.github/scripts/release-versioning.test.js

🚧 Files skipped from review as they are similar to previous changes (1)

.github/scripts/release-versioning.test.js

📝 Walkthrough

Walkthrough

Computes the previous non-RC release tag, derives a changelog range, exports it from the release-versioning script, adds tests for the helper, and threads the changelog_range through the release-candidate workflow into git-cliff.

Changes

Cohort / File(s)	Summary
Changelog range logic `.github/scripts/release-versioning.js`	Adds and exports `findPreviousTag(tags, newTag)`; computes `previousTag` and `changelogRange`, logs them, exposes `changelog_range` output and step-summary entries.
Tests `.github/scripts/release-versioning.test.js`	Adds comprehensive tests for `findPreviousTag()` covering normal, first-release, RC-only, excluding new tag, semantic ordering, non-semver, and numeric-sorting scenarios.
Workflow integration `.github/workflows/release-candidate-version.yml`	Adds `changelog_range` input/output, wires prepare job output into `CHANGELOG_RANGE` env, and conditions git-cliff invocation to use the provided range or fall back to `--latest`.

Sequence Diagram(s)

mermaid
sequenceDiagram
participant Workflow as Release Workflow
participant Script as release-versioning.js
participant Git as Git (tags)
participant GitCliff as git-cliff

Workflow->>Script: run prepare job
Script->>Git: list tags
Git-->>Script: tags list
Script->>Script: findPreviousTag(tags, newTag) -> previousTag, changelogRange
Script-->>Workflow: set output changelog_range
Workflow->>GitCliff: invoke with CHANGELOG_RANGE (or --latest)
GitCliff->>Git: generate changelog for range

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

kind/chore

Suggested reviewers

matthiasbruns
jakobmoellerdev

Poem

🐇 I hopped through tags both near and far,
Skipped the RCs and found the star,
Poked git‑cliff with a tidy range,
Changelogs tidy, neat, and strange —
Carrots for releases, hip hooray! 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: adding logic to correct changelog commit range calculation by finding the previous non-RC tag for release workflows.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

📝 Coding Plan

Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

piotrjanik

LGTM, one corner case to check

On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

morri-son · 2026-03-17T18:31:31Z

@piotrjanik

LGTM, one corner case to check

I added a semver check and a test for your mentioned case.

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/scripts/release-versioning.js:
- Around line 256-267: findPreviousTag currently picks the highest stable tag
without ensuring it is older than newTag; update findPreviousTag to first parse
newTag via parseVersion and filter tags to only those stable tags whose semantic
version is strictly less than newTag's version (compare major, minor, patch
arrays element-wise using parseVersion results) before sorting and returning the
top candidate; reference parseVersion, newTag, and findPreviousTag in your
change so the comparison logic ensures returned tag is actually previous to
newTag.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9a67ed05-6dba-494b-8374-d59d2953a2f8

📥 Commits

Reviewing files that changed from the base of the PR and between e8e6452 and 2029d54.

📒 Files selected for processing (2)

.github/scripts/release-versioning.js
.github/scripts/release-versioning.test.js

🚧 Files skipped from review as they are similar to previous changes (1)

.github/scripts/release-versioning.test.js

…t-cliff On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

morri-son · 2026-03-18T10:32:58Z

@coderabbitai review

coderabbitai · 2026-03-18T10:33:04Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

matthiasbruns · 2026-03-18T10:45:28Z

just a nit - while checking your tests I was confused that RCs are not included. While the docs way "...stable semver..." I only made the connection after reading it again.

matthiasbruns

ignore my nit - I do not want to block because of nits

…ws (open-component-model#1971) On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com>  #### What this PR does / why we need it Add new function to calculate the latest previous non-RC tag to determine the correct range of commits for the changelog.  ## Summary by CodeRabbit * **Chores** * Improved release versioning to compute and expose the previous release tag and a concrete changelog range for release-candidate flows, pass that range into the changelog generator, and surface these values in step summaries and workflow outputs (first-release behavior preserved). * **Tests** * Added comprehensive tests covering prior-release detection, RC and edge-case scenarios to ensure correct changelog-range behavior.  --------- Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com> Co-authored-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

add new function to calculate the latest previous non-RC tag to deter…

e8e6452

…mine the correct range of commits for the changelog. On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

morri-son requested a review from a team as a code owner March 13, 2026 15:33

morri-son added the kind/bugfix Bug label Mar 13, 2026

github-actions Bot added component/github-actions Changes on GitHub Actions or within `.github/` directory size/m Medium labels Mar 13, 2026

matthiasbruns previously approved these changes Mar 16, 2026

View reviewed changes

piotrjanik reviewed Mar 17, 2026

View reviewed changes

Comment thread .github/scripts/release-versioning.test.js

piotrjanik reviewed Mar 17, 2026

View reviewed changes

added check on valid semver versions AND a non-rc tag

2029d54

On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

morri-son dismissed matthiasbruns’s stale review via 2029d54 March 17, 2026 18:29

morri-son requested review from matthiasbruns and piotrjanik March 17, 2026 18:30

coderabbitai Bot reviewed Mar 17, 2026

View reviewed changes

Comment thread .github/scripts/release-versioning.js Outdated

morrison-sap added 2 commits March 18, 2026 11:26

Merge remote-tracking branch 'upstream/main' into fix-changelog-in-gi…

b74af43

…t-cliff On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

improve regex to filter edge case reported by coderabbitai

3255551

On-behalf-of: Gerald Morrison (SAP) <gerald.morrison@sap.com> Signed-off-by: Gerald Morrison (SAP) <gerald.morrison@sap.com>

piotrjanik approved these changes Mar 18, 2026

View reviewed changes

morri-son enabled auto-merge (squash) March 18, 2026 10:43

matthiasbruns reviewed Mar 18, 2026

View reviewed changes

Comment thread .github/scripts/release-versioning.js

Merge branch 'main' into fix-changelog-in-git-cliff

105d6fe

matthiasbruns approved these changes Mar 19, 2026

View reviewed changes

morri-son merged commit 7842164 into open-component-model:main Mar 19, 2026
16 checks passed

This was referenced Mar 30, 2026

chore: rename version variables for clarity #2123

Merged

chore: streamline release workflows and CLI build versioning #2131

Merged

coderabbitai Bot mentioned this pull request Apr 8, 2026

fix(GHA): find all tags #2183

Merged

morri-son deleted the fix-changelog-in-git-cliff branch April 23, 2026 12:45

coderabbitai Bot mentioned this pull request May 8, 2026

feat: unified release flow for a single github release version #2468

Merged

5 tasks

Conversation

morri-son commented Mar 13, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Mar 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested labels

Suggested reviewers

Poem

Uh oh!

Uh oh!

piotrjanik left a comment

Choose a reason for hiding this comment

Uh oh!

morri-son commented Mar 17, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

morri-son commented Mar 18, 2026

Uh oh!

coderabbitai Bot commented Mar 18, 2026

Uh oh!

Uh oh!

matthiasbruns commented Mar 18, 2026

Uh oh!

matthiasbruns left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

morri-son commented Mar 13, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 13, 2026 •

edited

Loading