Bug #16405
release_process: fix mind-boggling instructions for --previous options
100%
Description
Spotted during the 3.10, 3.11, and 3.12 release processes…
The instructions regarding the --previous
options to pass to ./bin/tails-iuk-generate-upgrade-description-files
are rather confusing and almost entirely the opposite of current practice; the latter would rather be: pass --previous $iuk
for each iuk
in ${IUK_SOURCE_VERSIONS?:}
…
Subtasks
History
#1 Updated by anonym 2019-02-13 09:22:20
- Status changed from Confirmed to In Progress
Applied in changeset commit:tails|625ceaf03f6fc93e077acb1c95ce2cb6fa9871b9.
#2 Updated by anonym 2019-02-13 09:24:05
- Assignee changed from anonym to intrigeri
- % Done changed from 0 to 50
- QA Check set to Ready for QA
- Feature Branch set to doc/16405-previous-iuks
@intrigeri, could you just double-check that I didn’t mess this one up?
#3 Updated by intrigeri 2019-02-18 17:49:48
> intrigeri, could you just double-check that I didn’t mess this one up?
Thanks! I’m on it. I’ll come up with a proposal that fixes the obvious UX problem we have here, without removing useful info.
#4 Updated by intrigeri 2019-02-20 07:35:59
- Target version set to Tails_3.13
- QA Check changed from Ready for QA to Dev Needed
#5 Updated by intrigeri 2019-03-07 09:00:49
- Priority changed from Normal to Elevated
#6 Updated by intrigeri 2019-03-07 14:37:28
- Assignee changed from intrigeri to anonym
- QA Check changed from Dev Needed to Ready for QA
@anonym I’ve tried something, please let me know what you think. Feel free to summarily merge into master (if this doc looks better, at first glance, than what we have in there) and use the 3.13 release process as a “user” testing session for these instructions.
Once merged into master, please postpone this ticket to 3.14 and reassign to kibi for another round of review, that he can do while RM’ing 3.14 (he’s the one who formally raised this issue initially and I bet he’ll find at least a few mind-boggling bits in the newly written doc :)
Thanks in advance!
#7 Updated by intrigeri 2019-03-07 14:39:38
> intrigeri, could you just double-check that I didn’t mess this one up?
Meta:
- I acknowledge that the current instructions are mind-boggling, unclear, confusing, etc. And I think that anonym’s reasoning, that’s behind the commit message, is correct (even though the exact phrasing reveals the depth of the misunderstanding and thus how bad the current doc is). I.e. on what matters most, we’re on the same page! :)
- this piece of doc has grown over time when other RMs (mostly anonym) asked me to add info and expand it; I obviously did not do a good job at it but summarily removing information, that was meant to answer actual questions RMs have asked themselves/me, feels like a regression. If we only did that I’m concerned that we’ll re-add that info later, in one form or another, every time a RM gets confused or does a mistake due to lack of information. I’d rather spend time to fix the doc now, without losing useful info along the way. I thought the most efficient way for me to do so was to propose a branch and explains my rationales in the commit messages, instead of trying to convey my ideas to you here. So that’s what I’ve done.
#8 Updated by intrigeri 2019-03-11 14:34:55
- Assignee changed from anonym to CyrilBrulebois
@CyrilBrulebois can you please review this? If you prefer, feel free to summarily merge into master (if this doc looks better, at first glance, than what we have in there) and use the 3.14 release process as a “user” testing session for these instructions.
#9 Updated by CyrilBrulebois 2019-03-18 14:19:41
- Status changed from In Progress to Fix committed
- % Done changed from 50 to 100
Applied in changeset commit:tails|1d0b80038fd0cc3650bfa8e7d8652d660e389fea.
#10 Updated by CyrilBrulebois 2019-03-18 14:20:04
That looks very good, thanks!
Merged into master with fix-committed; will open a fresh ticket if there are still unclear things.
#11 Updated by CyrilBrulebois 2019-03-18 14:20:29
- QA Check changed from Ready for QA to Pass
#12 Updated by CyrilBrulebois 2019-03-20 14:27:00
- Status changed from Fix committed to Resolved