Project

General

Profile

Bug #16586

release_notes: please document release notes merging

Added by CyrilBrulebois 2 months ago. Updated 14 days ago.

Status:
Resolved
Priority:
Normal
Assignee:
-
Category:
-
Target version:
Start date:
03/21/2019
Due date:
% Done:

0%

QA Check:
Feature Branch:
Type of work:
Contributors documentation
Blueprint:
Starter:
Affected tool:

Description

With previous releases, sajolida was helpful pointing me to the branch with release notes, so that it gets merged in time. I think there are not mentioned at all (except for reproducibility debugging — way before, and tweeting — way after), and it would be great to mention merging that branch right before or after the “Numerous_security_holes_in_[…]” section, so that they aren't forgotten by anyone.

Associated revisions

Revision 31b7b34d (diff)
Added by intrigeri about 1 month ago

Make release notes writing instructions consistent with the implicit expectations of our release process doc (Closes: #16586)

Our release process assumes that tech writers will push the release notes
directly to the $WEBSITE_RELEASE_BRANCH (web/release-${TAG:?}) branch. But the
tech writers doc told them to do something else. Let's resolve this conflict.

History

#1 Updated by intrigeri about 2 months ago

  • Assignee set to sajolida
  • QA Check set to Info Needed

@sajolida, may I update your doc to instruct you to push the release notes directly to the branch that's dedicated to preparing the web part of the release, instead of to a new one?

I think there are not mentioned at all (except […]), and it would be great to mention merging that branch right before or after the “Numerous_security_holes_in_[…]” section, so that they aren't forgotten by anyone.

Release notes are mentioned right before the Numerous_security_holes_in_[?] section already:

Ensure our [[contribute/working_together/roles/technical_writer]] has
[[written|contribute/how/documentation/release_notes]] the
announcement for the release in `wiki/src/news/version_${TAG:?}.mdwn`.

Write an announcement listing the security bugs affecting the previous
version in
`wiki/src/security/Numerous_security_holes_in_${PREVIOUS_VERSION:?}.mdwn

But indeed, our release process assumes that tech writers will push the release notes directly to the $WEBSITE_RELEASE_BRANCH (web/release-${TAG:?}) branch, while their own doc (wiki/src/contribute/how/documentation/release_notes.mdwn) tells them to do something else.

#2 Updated by sajolida about 2 months ago

  • Assignee changed from sajolida to intrigeri
  • QA Check changed from Info Needed to Dev Needed

Sure!

#3 Updated by intrigeri about 1 month ago

  • Status changed from Confirmed to Resolved
  • % Done changed from 0 to 100

#4 Updated by intrigeri about 1 month ago

  • Assignee deleted (intrigeri)
  • Target version set to Tails_3.14
  • % Done changed from 100 to 0
  • QA Check deleted (Dev Needed)

#5 Updated by intrigeri 16 days ago

  • Target version changed from Tails_3.14 to Tails_3.13.2

#6 Updated by anonym 15 days ago

  • Target version changed from Tails_3.13.2 to Tails_3.14

#7 Updated by intrigeri 14 days ago

  • Target version changed from Tails_3.14 to Tails_3.13.2

Also available in: Atom PDF