Prepare release 3.10.0 #3094

ann0see · 2023-07-01T21:35:59Z

Target timeline


Scheduled feature freeze / Start of translation process:	2023-07-30
Targeted translation completion date:	2023-08-20
Approximate release date:	2023-09-03
Current state:	Released

Checklist

Assign this issue to the release shepherd who is in charge of managing this checklist. (skipped)
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.
Start App translations (moved in 3.10.0 - template to be updated)
- Generate .ts files in main via lupdate and merge to main
- Create issues on Github, assigned to translators, for the new release: (skipped due to overhead - should we simplify this?)
  - Check if the list of translators in tools/create-translation-issues.sh is up-to-date. (skipped?)
  - Make sure issue text is up-to-date.
  - Create a translation issue for each language with tools/create-translation-issues.sh using app argument.
- Create an announcement on Weblate telling translators about the new release
Start Website translations
- Check ./Jamulus -h output against the Include-Client/Server-Commands.md pages and man page (distributions/Jamulus.1). Update if necessary.
- Check for broken links
- 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.
- Create an announcement on Weblate telling translators about the new release
- Create issues on Github, assigned to translators, for the new release: (skipped due to overhead - should we simplify this?)
  - Check if the list of translators in tools/create-translation-issues.sh is up-to-date.
  - Make sure issue text is up-to-date.
  - Add any URLs that will need localization 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.
Update the Changelog
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 and/or Weblate 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 (including new screenshots)
- Wait for all PRs to be merged (missing translations will revert to English automatically)
- Check for broken links
Check the milestone for mergable stuff again
Update the Changelog
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
Update the Changelog
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
- Disable branch protection rule of the release branch by clicking on "Edit" on the Branches page and adding a _ behind release. (Not needed in this release)
- Publish Website release by squashing and merging next-release into release
- Enable branch protection rule of the release branch after the site and the .po files are published by removing the _ from the branch protection rule you edited on the Branches page. (Not needed in this 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

The text was updated successfully, but these errors were encountered:

ann0see · 2023-07-24T19:54:50Z

I think if we get the GPG key sorted out, only documentation is missing.

ann0see · 2023-07-24T20:35:08Z

Release announcement should document that < Windows 10 devices will no longer work and macOS legacy is now no longer officially supported.

pljones · 2023-07-29T15:57:36Z

Find Merge commits since last release tag (r3_9_1) where no milestone has been set (so they're not set for 3.10.0, although they're in it) - for jamulussoftware/jamulus:
echo '{ "merge_commits": ['; git log --graph --oneline r3_9_1.. | grep '^\*' | grep 'Merge' | sed -e 's/^.* #$[0-9]*$.*$/\1/' | while read pr; do gh pr view --json number,author,assignees,state,milestone $pr | jq -cM 'select(.milestone.title != "Release 3.10.0") | { "number": .number, "author": .author.login, "assignees": .assignees|map(.login), "state": .state, "milestone": .milestone.title}'; done; echo ']'; echo '}'

{ "merge_commits": [
    {"number":3057,"author":"ann0see","assignees":[],"state":"MERGED","milestone":null},
    {"number":3053,"author":"app/dependabot","assignees":[],"state":"MERGED","milestone":null},
    {"number":3051,"author":"app/github-actions","assignees":[],"state":"MERGED","milestone":null},
    {"number":2833,"author":"ann0see","assignees":[],"state":"MERGED","milestone":null},
    {"number":3025,"author":"app/github-actions","assignees":[],"state":"MERGED","milestone":null},
    {"number":3015,"author":"app/github-actions","assignees":[],"state":"MERGED","milestone":null},
    {"number":2964,"author":"app/dependabot","assignees":[],"state":"CLOSED","milestone":null}
]}

I'll get those updated.

pljones · 2023-07-29T16:24:39Z

These appear to be the commits to jamulussoftware/jamulus main without a PR:

* / / 4237dcb2 Add JSON- RPC server connection tips (#3101)
* | | | 0fc62759 Update qm files
* | | | e25567a5 Update .ts files
* | | da4fee94 Display server title correctly in dark mode (#3008)
* / / / 07722bfa Update .qm files
* | dd01e008 Maintenance: Remove references to master branch
* 70757086 Set version to 3.9.1dev

4237dcb and da4fee9 had PRs but presumably not merge commits.

07722bf, 0fc6275 and e25567a appear to relate to weblate - not sure why these were merged to main directly?

dd01e00 this looks like the only one without a PR that possibly "should" have had one. I've mentioned it in #2840, which looks like the right issue for it.

7075708 documented in the 3.9.1 preparation guide.

ann0see · 2023-07-29T16:41:35Z

Qm and ts file updates are not PR worthy, I'd say. We'll push these directly to main per release process.

The squashes are due to PRs which had too many commits.

pljones · 2023-07-29T17:33:42Z

I was going to do a similar review of jamulussoftware/jamuluswebsite but ... it looks like it works differently in general, without merge commits. That means finding the PRs is difficult.

I noticed there are two commits on release called

RELEASE: Update Website for post 3.9.1 release

3c06e15d 2022-10-18 (#853) and 4712042b 2022-11-01 (#866) - but there's no actual release tag.

HEAD of release is at 818929de 2023-06-21.

On next-release, there's a whole load of commits from 10058386 2022-11-02 through to 99637288 2023-06-20 before:

5615c9f8 2023-06-21 Merge release into next-release [github-actions[bot]]

and, of course, some more after.

ann0see · 2023-07-29T17:55:18Z

The website doesn't have a tag since the release branch is basically the current state. In the beginning we thought that for each release we'd have a squash.

ann0see · 2023-07-29T18:03:46Z

I believe we can declare a freeze for the code after #3106 is merged. The website still needs some investigation (man page check, broken links, macOS change)

ann0see · 2023-07-29T18:09:33Z

Updated checklist with Weblate amendments.

https://github.com/jamulussoftware/jamuluswebsite/blob/next-release/wiki/en/Running-a-Server.md#server-mode-related-options is probably the new link to server commands.

ann0see · 2023-07-29T18:26:18Z

Findings:
jamulus -h needs an update from directoryserver --> directoryaddress (and the man page)
I think the website is up to date.

The code seems to be correct. Not sure why Jamulus -h outputs the wrong help text. Will compile again.

ann0see · 2023-07-29T18:44:16Z

Updated the .ts and .qm files now: 8aa28e9

pljones · 2023-07-30T09:09:38Z

The code seems to be correct. Not sure why Jamulus -h outputs the wrong help text. Will compile again.

I get

  -e, --directoryaddress  address of the Directory with which to register
                          (or 'localhost' to run as a Directory)

ann0see · 2023-07-30T09:58:30Z

Yes. After a new compile it's ok. Probably I used an outdated version

ann0see · 2023-07-30T10:01:45Z

I'd declare the code now as frozen. The website has some smaller PRs.

We can Tag a beta soon. @pljones feel free to do so

pljones · 2023-07-30T10:36:06Z

Are we still raising translation issues?

Notify all the translators that translation is required
Use tools/create-translation-issues.sh to create and assign issues (see usage notes in script). Also post on GH and Discord to notify.

ann0see · 2023-07-30T10:52:57Z

Yes. (But only for the app for now as the website is still in progress - macOS is outstanding).

pljones · 2023-07-30T10:57:56Z

And does this look okay from the Autobuild?

Run ./.github/autobuild/get_build_vars.py
JAMULUS_PRO_VERSION='3.10.0beta1'
building a version of type "release": 3.10.0beta1
BUILD_VERSION='3.10.0beta1'
PUBLISH_TO_RELEASE='false'

pljones · 2023-07-30T11:00:44Z

OK, the translations script has a problem:

$ ./tools/create-translation-issues.sh 3.10.0 2023-08-20 app
Creating app translation issues
Creating Issue to translate de_DE for 3.10.0
Updating Issue to translate de_DE for 3.10.0
Creating Issue to translate es_ES for 3.10.0
Updating Issue to translate es_ES for 3.10.0
Creating Issue to translate fr_FR for 3.10.0
Updating Issue to translate fr_FR for 3.10.0
Creating Issue to translate it_IT for 3.10.0
Updating Issue to translate it_IT for 3.10.0
Creating Issue to translate ko_KR for 3.10.0
GraphQL: Could not resolve to a User with the login of 'bagjunggyu'. (u000)

If the assigned user isn't visible on Github, the script bails out. It would be better if it assigned it to whoever's running the script...

I've applied:

5beaac4 2023-07-30 create-translation-issues: remove "bagjunggyu" and use gh login [Peter L Jones]

ann0see · 2023-07-30T11:17:11Z

@pljones I think you need to tag the commit as r3_9_1beta1 (due to our bad naming, I think it's not r3_10_0beta1, however, tagging it as RC is probably best as we're further in the release then last time. So for RCs r3_10_0rc1 would be ok)

ann0see · 2023-07-30T11:18:18Z

Also something broke the release checklist... Probably the script overwrote it ;-) (see description of this issue.)

pljones · 2023-07-30T11:19:50Z

Also something broke the release checklist... Probably the script overwrote it ;-) (see description of this issue.)

Ugh.... I was wondering where the Korean had gone. How on earth did it manage that!

Better check that commit I made ... :(

ann0see · 2023-07-30T11:21:18Z

No problem - the edit history is still there. I've created #3133

pljones · 2023-07-30T11:22:33Z

@pljones I think you need to tag the commit as r3_9_1beta1 (due to our bad naming, I think it's not r3_10_0beta1, however, tagging it as RC is probably best as we're further in the release then last time. So for RCs r3_10_0rc1 would be ok)

The Release Process should explain the naming convention clearly... I thought I'd followed it but was a bit suspicious...

ann0see · 2023-07-30T11:25:04Z

See edited by pljones:

softins · 2023-08-24T15:55:56Z

Check for conflicting accelerator keys (see tools/checkkeys.pl)

I ran tools/checkkeys.pl from the commandline in the root directory and got
Possible duplicate hotkeys:
@softins does that mean that everything is ok?
It was only ever an aid to manual checking, not a fully automated check. I haven't tried it recently, but will have a go on the current main.

The checkkeys.pl script needs to be run in the src/translation directory, where the *.ts files are. Otherwise, it just exits without doing anything. So:

tony@pi:~/jamulus $ cd src/translation
tony@pi:~/jamulus/src/translation $ ../../tools/checkkeys.pl
Language: de_DE
Language: es_ES
Language: fr_FR
......

I have just run it in the current main branch, and the output is at https://gist.github.com/softins/65a46e8aa1582a028ebc9bc97fce667f

Where multiple items are listed for a key, it is necessary manually to check and understand whether those items are conflicting in the same context, or are independent, for example by being in different drop-down menus. I never worked out how to enhance the script to be able to do so intelligently itself.

ann0see · 2023-08-24T18:44:30Z

Ok. Thank you very much for the information. I think this should be documented somewhere.

softins · 2023-08-25T13:56:51Z

I am just going through the manual checking on 3.10.0rc2. Almost all ok, but a small number of conflicts. I will raise a PR for the corrections today or tomorrow.

softins · 2023-08-26T11:38:43Z

I am just going through the manual checking on 3.10.0rc2. Almost all ok, but a small number of conflicts. I will raise a PR for the corrections today or tomorrow.

See #3156

pljones · 2023-08-28T12:12:03Z

Hm. Don't the app translations need completing and builds created so that the new screenshots for the website translations can be done? At the moment, the app translation follows the website - it should really come first.

ann0see · 2023-08-28T13:30:55Z

Yes. That would make more sense

jujudusud · 2023-08-28T13:46:32Z

Hm. Don't the app translations need completing and builds created so that the new screenshots for the website translations can be done? At the moment, the app translation follows the website - it should really come first.

We need to split the translation project on Weblate as it is on github. Then it will be possible. In addition, the issues need to go into the right project on github, the script also needs to be split.

pljones · 2023-08-28T13:58:58Z

The script has app and web arguments and should create the issues in the right project already. (Not checked - no reason it shouldn't, though.) The script could (does?) support separate app and web translator lists, too. My main concern is that it can't notify Weblate translators directly yet.

henkdegroot · 2023-08-28T15:56:16Z

Hm. Don't the app translations need completing and builds created so that the new screenshots for the website translations can be done? At the moment, the app translation follows the website - it should really come first.

The checklist has Finish App Translation (which includes generating .qm files) before Finish Website Translation (or did you already update that?)

comradekingu · 2023-08-28T15:57:27Z

Localized screenshots would be great, but source strings ones would help in the same manner.
If not fully automated, maybe put off the localized ones till all source strings are in good shape.
It is possible to manually arrange the listing of components on Weblate, by attributing priority.
Not sure that is the issue raised.
There is an API to reach translators via announcements.

pljones · 2023-08-28T17:48:55Z

(or did you already update that?)

Yeah, updated this - not the template.

ann0see · 2023-08-29T18:38:09Z

@comradekingu @pljones thanks for the information. Could you please put this information into https://github.com/orgs/jamulussoftware/discussions/3140 I hope that we can make the Weblate process a bit more smooth.

ann0see · 2023-08-31T18:13:48Z

#3164 needs a change log entry. Also the Weblate PRs need to be documented.

ann0see · 2023-09-03T18:17:30Z

@pljones @gilgongo could you please have a look at the release announcement? From first sight, I believe we are almost ready to tag the release.

ann0see · 2023-09-03T18:28:05Z

I believe we need a release retrospective here - especially for the weblate stuff raised by @pljones ...

ann0see · 2023-09-03T20:20:46Z

Ok. Tagged the release: https://github.com/jamulussoftware/jamulus/releases/tag/r3_10_0 Waiting on the build.

ann0see · 2023-09-03T20:41:57Z

Smoke tests:

Linux Debian x86_64 build works (also installed via repo)
macOS Client (Intel non legacy) works
Windows 10 11 - ~~ASIO4ALL doesn't open but JACK Router shows output. Needs an external test~~ Tested working by DonC

pljones · 2023-09-04T16:37:56Z

Windows 11 tested for ASIO (via ReaRoute) and JACK (also using ReaRoute... I like Reaper).

ann0see · 2023-09-04T17:17:20Z

@corrados I believe we can update the Directories to the new Release?

We're only missing a signed macOS build. @emlynmac is AFK for the moment, so this could take some time.

corrados · 2023-09-04T18:44:59Z

It's done:

Thank you for creating the new version :-)

ann0see · 2023-09-05T07:00:58Z

Thank you very much @corrados

pljones · 2023-09-05T17:34:40Z

Both there now:

pljones · 2023-09-05T17:45:09Z

OK... if we're going to push our Debian/Ubuntu repo, we should change the front page "Download" links so the Debian/Ubuntu one points to the guide on setting up the install repo.

So Debian/Ubuntu should be Debian/Ubuntu. (And change Download to Install, too.)

One line version, by the way:

{ curl -s https://raw.githubusercontent.com/jamulussoftware/jamulus/main/linux/setup_repo.sh \
  && echo 'apt install jamulus'; } | sudo bash -e

(or apt install jamulus-headless). Note that I got

E: Could not get lock /var/lib/apt/lists/lock. It is held by process 145119 (apt-get)
E: Unable to lock directory /var/lib/apt/lists/

because apt-daily.service was running (in fact, mine had crashed a couple of days ago, so it was worth me finding out!).

pljones · 2023-09-05T18:39:26Z

Facebook announcement posted.

ann0see · 2023-09-10T10:20:47Z

Release retro: https://github.com/orgs/jamulussoftware/discussions/3171

pljones · 2023-09-18T18:36:35Z

[ ] Update this template in https://jamulus.io/contribute/Release-Process with any improvements if needed.

Moving to release retro, closing here.

pljones · 2023-09-18T18:41:36Z

Unpinned and closed.

ann0see added this to the Release 3.10.0 milestone Jul 1, 2023

ann0see added this to Tracking Jul 1, 2023

github-project-automation bot moved this to Triage in Tracking Jul 1, 2023

ann0see moved this from Triage to In Progress in Tracking Jul 10, 2023

ann0see pinned this issue Jul 10, 2023

ann0see mentioned this issue Jul 28, 2023

RELEASE: 3.10.0 (WEBSITE) jamulussoftware/jamuluswebsite#940

Merged

pljones unpinned this issue Sep 18, 2023

pljones closed this as completed Sep 18, 2023

github-project-automation bot moved this from In Progress to Done in Tracking Sep 18, 2023

Prepare release 3.10.0 #3094

Prepare release 3.10.0 #3094

Comments

ann0see commented Jul 1, 2023 • edited by pljones Loading

ann0see commented Jul 24, 2023

ann0see commented Jul 24, 2023

pljones commented Jul 29, 2023 • edited Loading

pljones commented Jul 29, 2023 • edited Loading

ann0see commented Jul 29, 2023

pljones commented Jul 29, 2023

ann0see commented Jul 29, 2023

ann0see commented Jul 29, 2023

ann0see commented Jul 29, 2023 • edited Loading

ann0see commented Jul 29, 2023 • edited Loading

ann0see commented Jul 29, 2023

pljones commented Jul 30, 2023 • edited Loading

ann0see commented Jul 30, 2023

ann0see commented Jul 30, 2023

pljones commented Jul 30, 2023

ann0see commented Jul 30, 2023 • edited Loading

pljones commented Jul 30, 2023

pljones commented Jul 30, 2023 • edited Loading

ann0see commented Jul 30, 2023

ann0see commented Jul 30, 2023

pljones commented Jul 30, 2023 • edited Loading

ann0see commented Jul 30, 2023

pljones commented Jul 30, 2023 • edited Loading

ann0see commented Jul 30, 2023

softins commented Aug 24, 2023

ann0see commented Aug 24, 2023

softins commented Aug 25, 2023

softins commented Aug 26, 2023

pljones commented Aug 28, 2023

ann0see commented Aug 28, 2023

jujudusud commented Aug 28, 2023 • edited Loading

pljones commented Aug 28, 2023 • edited Loading

henkdegroot commented Aug 28, 2023

comradekingu commented Aug 28, 2023

pljones commented Aug 28, 2023

ann0see commented Aug 29, 2023

ann0see commented Aug 31, 2023

ann0see commented Sep 3, 2023

ann0see commented Sep 3, 2023

ann0see commented Sep 3, 2023

ann0see commented Sep 3, 2023 • edited Loading

pljones commented Sep 4, 2023

ann0see commented Sep 4, 2023

corrados commented Sep 4, 2023

ann0see commented Sep 5, 2023

pljones commented Sep 5, 2023

pljones commented Sep 5, 2023 • edited Loading

pljones commented Sep 5, 2023

ann0see commented Sep 10, 2023

pljones commented Sep 18, 2023

pljones commented Sep 18, 2023

ann0see commented Jul 1, 2023 •

edited by pljones

Loading

pljones commented Jul 29, 2023 •

edited

Loading

pljones commented Jul 29, 2023 •

edited

Loading

ann0see commented Jul 29, 2023 •

edited

Loading

ann0see commented Jul 29, 2023 •

edited

Loading

pljones commented Jul 30, 2023 •

edited

Loading

ann0see commented Jul 30, 2023 •

edited

Loading

pljones commented Jul 30, 2023 •

edited

Loading

pljones commented Jul 30, 2023 •

edited

Loading

pljones commented Jul 30, 2023 •

edited

Loading

jujudusud commented Aug 28, 2023 •

edited

Loading

pljones commented Aug 28, 2023 •

edited

Loading

ann0see commented Sep 3, 2023 •

edited

Loading

pljones commented Sep 5, 2023 •

edited

Loading