Skip to content

Conversation

lovisaberggren
Copy link
Collaborator

@lovisaberggren lovisaberggren commented Aug 13, 2025

Proposed changes

In the IPA release workflow, adding a step to create a release tag for the latest commit. The release tag follows the pattern ipa-validation-ruleset-vX.X.X to distinguish from the FOAS CLI release tags.

These tags can then be used in the changelog generation to be able to parse which commits are included in which release.

Changes:

  • In IPA package release, added step to create release tag. When workflow is run manually, there is an option to use an existing tag
  • Adjusted the changelog PR test we have to only allow changelog changes when version is bumped

Added tag retroactively to first IPA release: https://github.com/mongodb/openapi/releases/tag/ipa-validation-ruleset-v0.0.1

Tested changelog with temporary tag on this branch.

Jira ticket: CLOUDP-337866

echo "Changelog diff: ${diff_changelog}"
if [[ "${VERSION_BUMP}" == "false" && -n "${uncommitted_changes}" ]]; then
if [[ "${VERSION_BUMP}" == "false" && -n "${diff_changelog}" ]]; then
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Disallow any changes to changelog if version is not bumped

# Check CHANGELOG.md is the generated changelog result
uncommitted_changes=$(git status --porcelain | grep "CHANGELOG.md" || echo "")

if [[ "${VERSION_BUMP}" == "true" && -n "${uncommitted_changes}" ]]; then
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

When version is bumped, ensure generated changelog is the same as committed

Comment on lines +39 to +46
"package": true,
"commitPattern": "[a-z]+\\(ipa\\):",
"startingVersion" : "0.0.1",
"hideCredit": true,
"tagPattern": "none",
"startingVersion": "ipa-validation-ruleset-v1.0.0",
"hideCredit": true,
"tagPattern": "ipa-validation-ruleset-v\\d+\\.\\d+\\.\\d+",
"tagPrefix": "ipa-validation-ruleset-v",
"hideEmptyReleases" : true,
"contributors": false,
"changeCount": 0
"contributors": false
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Adjust to use tag prefix for changelog

@lovisaberggren lovisaberggren marked this pull request as ready for review August 13, 2025 13:27
@lovisaberggren lovisaberggren requested review from a team as code owners August 13, 2025 13:27
Copy link
Contributor

@sphterry sphterry left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@lovisaberggren lovisaberggren merged commit e286298 into main Aug 13, 2025
12 checks passed
@lovisaberggren lovisaberggren deleted the CLOUDP-337866 branch August 13, 2025 14:34
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.

3 participants