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.

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

Fixes 1042: Clarify release tagging #1073

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Fixes 1042: Clarify release tagging #1073

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions contribute/en/Release-Process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,10 +305,10 @@ Current state: <!-- Planning|Translations (beta)|Code freeze (rc)|Released -->
- [ ] [Tag a release candidate](https://jamulus.io/contribute/Release-Process#steps-for-a-specific-release) (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](https://jamulus.io/contribute/Release-Process#steps-for-a-specific-release)
- [ ] [Update the Changelog](https://jamulus.io/contribute/Release-Process#updating-the-changelog)
- [ ] Tag this commit as `r3_y_z`
- [ ] Wait for the build to complete
- [ ] [Tag the release version](https://jamulus.io/contribute/Release-Process#steps-for-a-specific-release):
- [ ] Update the version number in `Jamulus.pro` and add the release date to the Changelog header and commit.
Copy link
Member

Choose a reason for hiding this comment

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

I think updating Jamulus.pro and Changelog need to be done and committed before tagging, otherwise the release will not contain the proper version and change log?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The details seem duplicated in the referenced section.

Copy link
Member

@ann0see ann0see Dec 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I'd prefer to have it here clearly as this avoids jumping. So roughly:

  1. Change Jamulus.pro and changelog version number
  2. Commit this and tag it as rx_y_z
  3. Add a new entry to the changelog and a update Jamulus.pro

Copy link
Contributor Author

@pljones pljones Dec 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

You mean everywhere we refer to steps-for-a-specific-release, copy the whole section in and get rid of that section, or what? If you don't do what that section says, you won't do it right.

Copy link
Member

@ann0see ann0see Dec 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

We should have the lowest friction as possible. So links are one step more. If we do link it, then also the "Update version number ..." stuff is unnecessary and we could just say "follow the release instructions on ..."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There are two flows:

  • tagging and releasing any tagged release, be it dev, beta, rc or final release
  • the additional steps necessary only when tagging a final release

What I was trying to do was make that clearer.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Latest version: http://jamuluswebsite.drealm.info/contribute/Release-Process#steps-for-a-specific-release
This probably still needs further work, to be honest. It's referenced as "Tag the release version" here but covers mostly translations:

1. Ensure .ts files are up to date (...)

2. Notify all the translators that translation is required (...)

3. Update the .ts files returned by translators (...)

4. When all translations have been submitted and merged. (...) <-- This is where tagging starts

If this is a proper release, move the latest tag (...) (this intended to be a sub-step of 4, I think)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe steps 1-3 should get split into "Translation Process" and step 4 and its sub-step should be "Release Tagging Process"?

Copy link
Contributor Author

@pljones pljones Dec 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Also, the section on updating the ChangeLog would be better placed, in the overall Release Process page, between the section about translations and the section on performing the release -- it needs to happen before the final release and it never gets mentioned in the tagging section(s) (just repeatedly from here, in the places it needs to be).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I also notice this doc doesn't appear to reference the steps in Release Process about the translations.

- [ ] Wait for the release build to complete.
- [ ] Contact emlynmac for signing on macOS and upload signed binary [from his](https://github.com/emlynmac/jamulus/releases/) repo [to ours](https://github.com/jamulussoftware/jamulus/releases).
- [ ] 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.](https://jamulus.io/contribute/Release-Process#if-this-is-a-proper-release-move-the-latest-tag)
Expand Down
Loading