Skip to content
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

Changelog helper tool updated #3459

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

softins
Copy link
Member

@softins softins commented Dec 31, 2024

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

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
@@ -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

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.)

"Android:"
"iOS:"
"Dependencies:"
"Translation:"
Copy link
Collaborator

@pljones pljones Jan 1, 2025

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

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Waiting on Team
Development

Successfully merging this pull request may close these issues.

"tools/changelog-helper.sh group-entries" grouping improvement suggestions
3 participants