Skip to content

Changelog helper tool updated #3459

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Apr 14, 2025
Merged

Changelog helper tool updated #3459

merged 6 commits into from
Apr 14, 2025

Conversation

softins
Copy link
Member

@softins softins commented Dec 31, 2024 •
edited
Loading

Short description of changes

Add improvements to tools/changelog-helper.sh:

  • extra grouping categories for Client/Server, Weblate, Qt6 updates and Dependencies.
  • fixed a bug where the last item before sorting had its trailing \n swallowed, making it join to another entry.

CHANGELOG: Internal: added improvements to changelog-helper.sh

Context: Fixes an issue?

Addresses some of the suggestions in #3319, but not all of them. Some would need a substantial re-implementation.

Does this change need documentation? What needs to be documented and how?

Not really - internal use only

Status of this Pull Request

Ready for review

What is missing until this pull request can be merged?

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I tested my code and it does what I want
  • My code follows the style guide
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I've filled all the content above

@softins softins requested a review from pljones December 31, 2024 15:43
@softins
Copy link
Member Author

softins commented Dec 31, 2024 •
edited
Loading

Suggest that existing post-3.11.0 entries be deleted from Changelog and re-added using this script before sorting. (Not because adding has changed, but I have edited the CHANGELOG entries in a couple of existing merged PRs that didn't have a category label)

@softins softins added this to the Release 3.12.0 milestone Dec 31, 2024
pljones
pljones reviewed Jan 1, 2025
View reviewed changes
tools/changelog-helper.sh
@@ -39,6 +39,8 @@ export GH_REPO=jamulussoftware/jamulus

PR_LIST_LIMIT=300
TRANSLATION_ENTRY_TEXT="GUI: Translations have been updated:"
TRANSLATION_ENTRY_TEXT2="Translations updated from Hosted Weblate"
BUNDLED_QT_UPDATE_TEXT="Build: Updated bundled Qt6"
Copy link
Collaborator

@pljones pljones Jan 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

There's a bunch of these defined in the bump dependencies workflow - it's probably worth covering all of them (separate groups). (It's Build: Updated + the changelog_name value.)

Copy link
Member Author

Choose a reason for hiding this comment

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

OK, done

pljones
pljones reviewed Jan 1, 2025
View reviewed changes
tools/changelog-helper.sh Outdated
"Android:"
"iOS:"
"Dependencies:"
"Translation:"
Copy link
Collaborator

@pljones pljones Jan 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Should all the translations be together (i.e. up with $TRANSLATION_ENTRY_TEXT and $TRANSLATION_ENTRY_TEXT2 - or down here with doc and website)?

Copy link
Member

Choose a reason for hiding this comment

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

Yes. There are some entries which are sorted by language.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've rearranged them so Translations: comes first, then Weblate, then the one starting with Gui:, so it groups with the Gui: section that follows. It seems that since 3.11.0 only the Weblate category has been used anyway.

@pljones pljones linked an issue Jan 1, 2025 that may be closed by this pull request
"tools/changelog-helper.sh group-entries" grouping improvement suggestions #3319
Closed
ann0see
ann0see reviewed Jan 1, 2025
View reviewed changes
Copy link
Member

@ann0see ann0see left a comment

Choose a reason for hiding this comment

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

Looks good.

@ann0see ann0see requested a review from pljones March 22, 2025 19:34
@ann0see ann0see requested a review from Copilot April 6, 2025 19:52
Copilot
Copilot AI reviewed Apr 6, 2025
View reviewed changes
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.

Files not reviewed (1)
  • tools/changelog-helper.sh: Language not supported

@ann0see
Copy link
Member

ann0see commented Apr 6, 2025

Just testing the copilot bot. Probably it doesn't work on our languages yet

@pljones
Copy link
Collaborator

pljones commented Apr 13, 2025

Still waiting on the comments here to be addressed.

@softins softins force-pushed the changelog-helper-update branch from 18e54a9 to 55e519f Compare April 13, 2025 15:17
@softins softins force-pushed the changelog-helper-update branch from c89308d to 8fdfe73 Compare April 13, 2025 16:18
@softins
Copy link
Member Author

softins commented Apr 13, 2025

Still waiting on the comments here to be addressed.

Let me know if there is anything else outstanding.

@pljones pljones merged commit 0f8ff3f into jamulussoftware:main Apr 14, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from Waiting on Team to Done in Tracking Apr 14, 2025
@softins softins deleted the changelog-helper-update branch April 14, 2025 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@pljones pljones pljones approved these changes

@ann0see ann0see ann0see approved these changes

Assignees

@softins softins

Labels
None yet
Projects
Tracking
Status: Done
Milestone
Release 3.12.0
Development

Successfully merging this pull request may close these issues.

"tools/changelog-helper.sh group-entries" grouping improvement suggestions
3 participants
@softins @ann0see @pljones