Fixes 1042: Clarify release tagging #1073
Conversation
| - [ ] 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
The details seem duplicated in the referenced section.
There was a problem hiding this comment.
I'd prefer to have it here clearly as this avoids jumping. So roughly:
- Change Jamulus.pro and changelog version number
- Commit this and tag it as rx_y_z
- Add a new entry to the changelog and a update Jamulus.pro
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 ..."
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
Maybe steps 1-3 should get split into "Translation Process" and step 4 and its sub-step should be "Release Tagging Process"?
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
I also notice this doc doesn't appear to reference the steps in Release Process about the translations.
|
Locking Weblate, then merging outstandings before I do this. |
|
Hmm. Yes. You're right. There was a webpage PR open on while I merged the other PR. 😐 |
pljones
force-pushed
the
bugfix/release-process-release-tagging
branch
from
33582a2 to
d607777
Compare
|
Weblate merged, updated weblate, rebased this, merged this, updated weblate again (probably didn't need the first one...), unlocked weblate. Hopefully that'll keep weblate calm... |
|
I've raised #1076 for my other comments. |
Short description of changes
Clarify release tagging instructions.
Context: Fixes an issue? Related issues
Fixes: 1042
Status of this Pull Request
Another point raised whilst I was going through the 3.11.0 release (very minor).
What is missing until this pull request can be merged?
Review.
Does this need translation?
The doc has translation copies.
Checklist