Prepare Release 3.8.2

[ann0see]

Target timeline
Scheduled feature freeze / Start of translation process: 2022-01-27
Targeted translation completion date: 2022-02-06 2022-02-13
Approximate release date: 2022-02-20
Current state: Released

Checklist

• Assign this issue to the release shepherd who is in charge of managing this checklist.
• Pin this issue
• Ensure that all issues/PR targeted for this release are done by checking the Project board with the appropriate filter for this release. Remind main developers to review entries in Waiting on team state.
• Agree to de-tag unfinished Issues/PRs.
• Declare a freeze for code and website by updating this Issue and adding a comment. PRs can still be worked on and may get reviewed, but must not be merged unless agreed explicitly.
• Check the needs documentation label for any outstanding PRs flagged for this release and remove that label if done.
• Check ./Jamulus -h output against the Include-Client/Server-Commands.md pages (wiki/en) and man page (distributions/Jamulus.1). Update if necessary.
• Write the Changelog based on the list of PRs in "done" state (example for 3.8.1)
• Start Website translations
  • Check for broken links with a link checker on the next-release branch and fix them
  • Open a Pull Request from next-release to release, set it as "Draft", sanity check for conflicts and any obvious problems.
  • Declare a full freeze of the next-release and release branch. No changes should be made from now on to ensure translators don't have to work twice.
  • Check if the list of translators in tools/create-translation-issues.sh. Make sure issue text is up-to-date. Add any URLs that will need localisation into the "New/Changed screenshots" section.
  • Create a translation issue for each language with tools/create-translation-issues.sh using web argument (see notes in script).
  • If anyone finds critical issues now, all translators must be made aware of them and all languages should be updated.
• Start App translations
  • Generate .ts files in master via lupdate
  • Check if the list of translators in tools/create-translation-issues.sh is up-to-date
  • Create a translation issue for each language with tools/create-translation-issues.sh using app argument.
• Tag a beta release
  • Inform emlynmac for signing on macOS, and upload signed binary from his repo to ours
  • Announce the beta release on Github Discussions. Pin the thread.
  • Get feedback on the stability and resource usage (memleaks?, crashes?, installation issues?) of the beta release
• Finish App translations
  • Review translation PRs according to release process checklist
  • Wait for all PRs to be merged (missing translations will revert to English automatically).
  • Check for conflicting accelerator keys (see tools/checkkeys.pl)
  • Generate .qm files via lrelease Jamulus.pro
• Finish Website translations
  • Wait for all PRs to be merged (missing translations will revert to English automatically)
  • Check for broken links with a link checker locally (run _po4a-tools/po4a-create-all-targets.sh locally first)
• Check the milestone for mergable stuff again
• Update the changelog again (we did have post-beta PRs which do not have an entry yet, so this is indepdendent of the previous item)
• Tag a release candidate (inform emlynmac for signing on macOS and upload signed binary from his repo to ours).
  • Announce the release candidate on Github Discussions. Pin the thread. Unpin and lock the beta thread.
  • Draft an announcement, include all contributors via tools/get_release_contributors.py
• Update the version number in Jamulus.pro and add the release date to the Changelog header and commit
• Tag this commit as r3_y_z
  • Wait for the build to complete
  • Contact emlynmac for signing on macOS and upload signed binary from his repo to ours.
  • Do a smoke test for Windows/Mac/Linux -- Do the binaries start/connect properly? Can earlier Jamulus versions properly connect to a server based on the new release?
  • Force tag that tag as latest and push.
  • Upload the artifacts to SourceForge and set defaults.
  • Update download links on the website by editing config.yml in next-release
  • Publish Website release by merging next-release into release
• Announce the new release with a summary of changes (+ link to the changelog for details) and a link to the download page
  • On Github Discussions in the Announcements section. Lock the announcement thread. Pin the thread. Unpin and lock release candidate thread.
  • On Facebook in the group "Jamulus (official group)". Turn off replies.
• Trigger the update notification by updating both Update Check Servers with the new version (@pljones for update02, email corrados for update01)
• [Prepare Jamulus.pro (dev suffix) and ChangeLog (add a header) for the next release
• Check that all Issues and PRs tagged for this release are in Done/Closed state.
• Close the release milestone in both jamulus and jamuluswebsite repos
• Create a milestone for the next minor release in jamulus and jamuluswebsite repos
• Update this template in https://jamulus.io/contribute/Release-Process with any improvements if needed.
• Unpin and close this issue
• Determine if a release retrospective is needed, create on Discussions if required

[ann0see]

@jamulussoftware/maindevelopers I opened a new release issue.

What should be included? Based on #2246 (comment)

[ann0see]

I‘d declare this mostly as a bug fix release without many new features.

[softins]

The biggest question is: are there any things currently in master since 3.8.1 that we would not want to include in 3.8.2?

[ann0see]

I doubt anything on master is critical.

[gilgongo]

I doubt anything on master is critical.

Does that mean everything in that list is going in then?

[pljones]

Does that mean everything in that list is going in then?

Plus some more since... :) But they all look like they're "Mostly Harmless"...

[gilgongo]

OK we better tag the relevant stuff for the release then in that case so we can see what we're dealing with.

EDIT: Now those on that initial list tagged I think: https://github.com/orgs/jamulussoftware/projects/2?card_filter_query=milestone%3A3.8.2

If there are any more, please tag those.

[softins]

I can't see any more open PRs that need to go into 3.8.2, nor issues that we need to address for it, so I suggest we declare a code freeze.

I can update the .ts files directly ready for the translators. There are more changes to them than one would expect for a bugfix release. Most of these are in fact not really new text, but reformatting of existing texts to use %1, %2, etc instead of chopping the strings up.

Who is going to be release shepherd? I'm happy to if no-one else wants to, but happy also to defer if someone does want to.

[softins]

I have written a ChangeLog for this release, and put it in #2249

[gilgongo]

OK I've opened The PR for the website jamulussoftware/jamuluswebsite#686. Declaring documentation freeze now.