Skip to content

[Issue #422] Fix script for generating release notes#424

Merged
widal001 merged 1 commit intomainfrom
issue-422-fix-release-filtering
Nov 19, 2025
Merged

[Issue #422] Fix script for generating release notes#424
widal001 merged 1 commit intomainfrom
issue-422-fix-release-filtering

Conversation

@widal001
Copy link
Collaborator

@widal001 widal001 commented Nov 19, 2025

Summary

Fixes the generate release notes script. The old script used the wrong query param to pass the config file to the generate release notes API (configuration_file instead of configuration_file_path)

Changes proposed

What was added, updated, or removed in this PR.

  • Fixes the config file query param in validate-and-generate-release-notes.sh

Context for reviewers

Testing instructions, background context, more in-depth details of the implementation, and anything else you'd like to call out or ask reviewers. Explain how the changes were verified.

To validate this I created a temporary [email protected] tag since the generate release notes API endpoint only works if the tag you pass is tied to a commit after the config files were added to the main branch of the repo.

Once we merge this in I'll delete that tag.

Additional information

Screenshots, GIF demos, code examples or output to help show the changes working as expected.

Here's the dry-run with the temporary v0.3.3 tag

Screenshot 2025-11-19 at 10 36 45 AM

Here's the comparison of all commits between the two tags, showing that we're filtering out non-relevant PRs.

Note

I've since deleted the temporary tag we created to validate this behavior.

Screenshot 2025-11-19 at 10 39 23 AM

The old script used the wrong query param to pass the config file
to the generate release notes API `configuration_file` instead of
`configuration_file_path`
@widal001 widal001 requested a review from jcrichlake November 19, 2025 15:40
@widal001 widal001 changed the title fix: script for generating release notes [Issue #422] Fix script for generating release notes Nov 19, 2025
@widal001 widal001 merged commit 166aa54 into main Nov 19, 2025
5 checks passed
@widal001 widal001 deleted the issue-422-fix-release-filtering branch November 19, 2025 16:11
@widal001
Copy link
Collaborator Author

Follow up note on closing this out: I deleted the temporary [email protected] tag that I used to validate these changes, so the diff link above won't work as expected anymore.

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.

2 participants