Skip to content

Fix: Skip new ser-ver-id for --release option (custom-release) #6683

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: dev-2.x
Choose a base branch
from

Conversation

t2gran
Copy link
Member

@t2gran t2gran commented Jun 3, 2025

Summary

This PR improve thecustom_release.py with enhanced logic on setting the correct serialization.version.id. The new logic work as follows:

The script will resolve what the next serialization version id (SID) should be. This is a complex task.
Here is an overview:

  1. If the --serVerId option exist, then the latest SID is bumped and used.
  2. If the --release option exist, then the current pom.xml SID is validated, if ok it is used,
    if not the script exit.
  3. All merged in PRs are checked. If a PR is labeled with 'bump serialization id' and the the
    HEAD commit is not in the latest release, then the last release SID is bumped and used.
  4. Finally, the script look at the upstream SID for the last release and the base. If the SID
    is not the same the SID of the last release is bumped. To find the upstream SIDs the script
    look at the git history/log NOT matching the project serialization version id prefix - this
    is assumed to be the latest SID for the upstream project.

Tip! If the '--release' option is used, then the serialization version id is NOT updated. Use the
'--serVerId' option together with the '--release' to force update the serialization version id.

The terms "current release" and "new release" was slightly misleading. I changed them to:

  • latest release (was current release). The last tagged release.
  • next release (was new release) . The new release to be created next. Current is still used to refer to the current content of e.g. pom.xml - next refer to the what the value will be after the release is made.

In addition to these terms the base release is used to refer to the release used as the starting point for the next release - witch might be the latest release, but could be any commit.

Issue

🟥 There is no issue for this.

Unit tests

🟥 There are no tests on the custom release script.

Documentation

✅ The doc is updated.

Changelog

🟥 This is to technical and minor to end up in the release notes.

Bumping the serialization version id

🟥 Does not have any effect on OTP at all.

@t2gran t2gran requested a review from a team as a code owner June 3, 2025 19:48
Copy link

codecov bot commented Jun 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.58%. Comparing base (bb7eba1) to head (83c7234).
Report is 195 commits behind head on dev-2.x.

Additional details and impacted files
@@              Coverage Diff              @@
##             dev-2.x    #6683      +/-   ##
=============================================
+ Coverage      71.40%   71.58%   +0.17%     
- Complexity     18569    18932     +363     
=============================================
  Files           2035     2059      +24     
  Lines          76553    77467     +914     
  Branches        7824     7900      +76     
=============================================
+ Hits           54664    55454     +790     
- Misses         19116    19198      +82     
- Partials        2773     2815      +42     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@t2gran t2gran marked this pull request as draft June 4, 2025 09:11
@t2gran t2gran force-pushed the fix_release_script branch from dfe4fa0 to 10babda Compare June 4, 2025 16:14
@t2gran t2gran force-pushed the fix_release_script branch 2 times, most recently from 6559f84 to d64ce47 Compare June 5, 2025 07:54
@t2gran t2gran force-pushed the fix_release_script branch from d64ce47 to 88f4f8e Compare June 5, 2025 11:11
@t2gran t2gran marked this pull request as ready for review June 5, 2025 11:11
@t2gran t2gran requested a review from vpaturet June 5, 2025 11:12
@t2gran t2gran added the Entur Test This is currently being tested at Entur label Jun 5, 2025
@t2gran t2gran added this to the 2.8 (next release) milestone Jun 5, 2025
@t2gran t2gran removed the Entur Test This is currently being tested at Entur label Jun 5, 2025
@leonardehrenfried leonardehrenfried requested a review from tkalvas June 5, 2025 13:42
@t2gran t2gran requested a review from tkalvas June 10, 2025 11:17
@t2gran t2gran added the Entur Test This is currently being tested at Entur label Jun 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Entur Test This is currently being tested at Entur Skip Changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants