Release Management/Release Notes: Difference between revisions

Release Management/Release Notes (view source)

Revision as of 20:01, 3 May 2023

5,751 bytes added , 3 May 2023

no edit summary

Dmeehan

383

edits

@@ Line 3: / Line 3: @@
 == About Firefox Release Notes ==
-Every four weeks, Firefox desktop and Firefox for Android release a new version of the browser. We publish release notes on [https://www.mozilla.org/firefox/releases/ mozilla.org] for an audience of web developers, tech press, and advanced and technical users of Firefox who want to be informed about the changes in Firefox's latest updates.
+Every four weeks, Firefox desktop, Firefox for Android, and Firefox for iOS release a new version of the browser. We publish release notes on [https://www.mozilla.org/firefox/releases/ mozilla.org] for an audience of web developers, tech press, and advanced and technical users of Firefox who want to be informed about the changes in Firefox's latest updates.
-The release notes page lists notable new features, changes, or unfixed critical bugs for a specific release of Firefox. Adding release notes content is the responsibility of the release management team, as requested by engineering/product and reviewed by a product writer.
+The release notes page lists notable new features, changes, or unfixed critical bugs for a specific release of Firefox. Adding release notes content is the responsibility of the release management team, as requested by engineering/product.
-See [https://wiki.mozilla.org/Release_Management/Release_Notes_Nomination Firefox Release Notes Nomination ] for information on how to nominate release notes for Firefox.
+For complex software such as Firefox with thousands of patches during a cycle and external contributors, tracking what should be noted in release notes is not always easy. Release management monitor patches that land in Central during the nightly cycle and will ask about potential release note inclusion. However, release management also relies on Engineering/Product to nominate when applicable. See [https://wiki.mozilla.org/Release_Management/Release_Notes_Nomination Firefox Release Notes Nomination ] for information on how to nominate release notes for Firefox.
 Examples of past release notes:
-* [https://www.mozilla.org/en-US/firefox/android/103.0/releasenotes/ Firefox 103 for Android]
 * [https://www.mozilla.org/firefox/103.0/releasenotes/ Firefox 103 for Desktop]
 * [https://www.mozilla.org/firefox/103.0beta/releasenotes/ Firefox 103 Beta for Desktop]
 * [https://www.mozilla.org/firefox/103.0a1/releasenotes/ Firefox Nightly 103 for Desktop]
+* [https://www.mozilla.org/firefox/android/103.0/releasenotes/ Firefox 103 for Android]
+* [https://www.mozilla.org/firefox/ios/103.0/releasenotes/ Firefox 103 for iOS]
 Here is the full list of [https://www.mozilla.org/firefox/releases/ past Firefox release notes].
@@ Line 21: / Line 22: @@
 Release notes for the Release channel are published on the day we ship Firefox to our users. They are not maintained continuously during the Release Cycle. A new release note page is published for any dot releases during the release cycle.
-The release management team maintains release notes for Firefox Desktop and Firefox for Android only. Release notes for other products are not in our scope at the moment.
+The release management team maintains release notes for Firefox Desktop, Firefox for Android, and Firefox for iOS only. Release notes for other products are not in our scope at the moment.
 For questions on the process please reach out on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel.
@@ Line 28: / Line 29: @@
 # Release management creates a Nightly release notes page in Nucleus for the upcoming version.
 # Release management makes the Nightly release notes public in Nucleus on Merge Day.
+# Release management shares a link to the Nightly release notes on #release-notes.
 # During the Nightly cycle, Release management monitors the relnote-firefox flag on Bugzilla and adds release notes for Nightly in Nucleus.
 # Release management creates a Beta release notes page in Nucleus for the upcoming version.
@@ Line 33: / Line 35: @@
 # Release management makes the Beta release notes public in Nucleus after pushing Beta 1 live.
 # Release management shares a link to the Beta release notes on #release-notes.
-# During the Beta cycle, Release management monitors the relnote-firefox flag on Bugzilla and adds release notes for Beta in Nucleus.
+# Release management creates a shared document for an editorial review and then shares it on #release-notes and to a mailing list.
-# Product writer creates a shared document for an editorial review and then shares it on #release-notes and to a mailing list.
+# Release management copy-pastes notes from Beta Release Notes to the shared document.
-# Product writer copy-pastes notes from Beta Release Notes to the shared document.
+# Engineering/Product may add notes directly to the shared document.
 # Release management continues to monitor the relnote-firefox flag on Bugzilla and add release notes in Nucleus and the shared document.
-# Engineering/Product may add notes directly to the shared document.
+# Release management/Engineering/Product performs an editorial review in the shared document.
-# Product writer performs an editorial review in the shared document.
 # Release management creates a release notes page in Nucleus for the upcoming version.
 # Release management copies the reviewed release notes from the shared document into Nucleus.
 # Release management adds links to security advisories and developer documentation for the release.
 # Release management shares a link to the staging release notes on #release-notes.
-# Release management makes the release notes public in Nucleus after pushing the Release live.
+# Release management makes the release notes public in Nucleus after pushing the release live.
+== Nightly - Gathering of notes during the Nightly cycle ==
+===At the start of the Nightly cycle===
+* Make a copy of the previous Nightly Release in Nucleus.
+** Update the version and release date.
+** Remove the release notes from the previous release, leaving only the nightly-only release notes.
+*** Ensure the note includes the nightly version that introduced it, for example:
+**** “Starting with Firefox 113, nightly builds…”
+**** “Starting with Firefox 112, nightly users…”
+*** Ensure to rank the nightly carry over release notes at the bottom.
+* Publish the Nightly release notes after central is bumped.
+* Share a link to the Nightly Release Notes on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel.
+* Create a copy of [https://docs.google.com/document/d/1w0oz7NSHrz81KKA7FNiRHRsyhCtz5o3PVnMAKYWEEoQ/edit draft release notes doc template]
+** Update the version and dates.
+** Ensure the document is shared with edit access for Mozilla.
-== Gathering of notes during the cycle ==
+===Daily during the Nightly cycle===
-For complex software such as Firefox with thousands of patches during a cycle and external contributors, tracking what should be noted in release notes is not always easy.
+* Look through all patches that land in central via [https://whattrainisitnow.com/nightly/ whattrainisitnow.com]
+** Identify if any patch is a candidate for release note nomination.
+*** Example: New feature or behavior change.
+** Needinfo the bug assignee and request if it should be considered for release note nomination
+*** "'':assignee'' could you please consider nominating this for a relnote? https://wiki.mozilla.org/Release_Management/Release_Notes_Nomination"
+* Review bugs that were nominated for release note inclusion.
+** Check if the wording is appropriate.
+** Check if the patch is nightly or early beta only.
+** Check the patches that landed. If the changes are behind a pref then check if the pref value is IS_NIGHTLY_BUILD, or IS_EARLY_BETA_OR_EARLIER
+** Add the release note in Nucleus.
+*** If the note is Nightly only use a html tag to indicate it’s nightly only.
+** Comment on the bug to inform that the note was added to nightly.
+*** "Thanks, added to Nightly release notes. Keeping the relnote? flag open to keep it on the radar for inclusion in our final release notes."
-Here is the main list of actions the release management team and product writers do to prepare release notes:
+== Beta - Refining notes during the Beta cycle ==
-* Check bugs nominated for release note addition for Nightly and add them to Nightly release notes if necessary.
-* Check mozilla-central commits daily for features potentially note-worthy. Ping the patch author and ask them to nominate the bug for release notes addition.
-* Ask people on several engineering mailing lists to tell us what note-worthy fixes are upcoming.
-* Share the final version of the release notes draft, ask for a review, and if there are any suggested changes.
-== Notes creation ==
+===At the start of the Beta cycle===
-=== Writing Notes: step by step process ===
+* Create a new beta release in Nucleus.
-* Release Management gathers the notes
+** Copy the release notes from nightly that are riding the train.
-** Check note nominees from Bugzilla's relnote-firefox:? Flag
+* Copy release notes to the release notes draft document.
-** Check with developers and managers as necessary to clarify.
+* Publish the release notes after pushed Beta 1 live.
-* First editing phase - Nightly/Beta
+* Share a link to the Beta Release Notes on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel.
-** Depending on where we are in the release cycle, Release Management adds release notes to Nightly or Beta in Nuclueus.
+** "FxNNN beta preliminary release notes: https://www.mozilla.org/firefox/NNN.0beta/releasenotes/. If you know of anything worth mentioning but is not yet listed, please reach out or nominate it for a release note in Bugzilla. We will follow-up with a link to the Firefox NNN Release Notes document."
-** Release Management shares the Beta draft for feedback and incorporates feedback.
+* Share a link to the draft release notes doc on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel. Include a link to the draft document and the submission deadline.
-* Second editing phase - Release
+{| class="wikitable"
-** Product Writer reviews and edits wording.
+|-
-** Release Management adds the edited notes into Nucleus.
+| Hi! We're at the start of the FxNNN Beta cycle, which means it is time for a new release notes cycle!
-** Release Management adds a note for security fixes pointing to our security advisories, this link is provided by the Security team:
+Draft template for the Firefox NNN Release Notes are here.
-*** '''Fixed''' - Various [https://www.mozilla.org/security/advisories/mfsa2018-06/ security fixes]
+The DEADLINE for submissions is ''Month Day, Year''.
-* Final edit phase
+This will give us time to make necessary edits and/or changes before publishing on ''Month Day, Year''.
-** Release Management shares the Release draft for feedback and incorporates feedback.
+Note: We are still monitoring relnote nomination in bugzilla via setting relnote-firefox? for FxNNN.
+|}
+* Send an email to the [https://groups.google.com/a/mozilla.com/g/release-notes release-notes] internal mail group. Include a link to the draft document and the submission deadline.
+** Example: https://groups.google.com/a/mozilla.com/g/release-notes/c/swrd1tuRejA
-=== Dot-Release Notes ===
+===Daily during the Beta cycle===
+* Review bugs that were nominated for release note inclusion.
+** Check if the wording is appropriate.
+** Add the release note in Nucleus and the draft document.
+** Comment on the bug to inform that the note was added to Beta
+* If an uplift in beta is to enable a feature to ride the train, ensure to remove the nightly only note from the current nightly release notes where applicable.
+===Midway through the Beta Cycle===
+* Send a reminder on the  [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel. Include a link to the draft document and the submission deadline.
+{| class="wikitable"
+|-
+| Hi! We're at the mid-point of the FxNNN Beta cycle, which means it is time for a release notes reminder!
+Draft template for the Firefox NNN Release Notes are here.
+The DEADLINE for submissions is ''Month Day, Year''.
+This will give us time to make necessary edits and/or changes before publishing on ''Month Day, Year''.
+Note: We are still monitoring relnote nomination in bugzilla via setting relnote-firefox? for FxNNN.
+|}
+* Send a reminder email to the [https://groups.google.com/a/mozilla.com/g/release-notes release-notes] internal mail group. Include a link to the draft document and the submission deadline.
+== Release - Finalizing notes ==
+===Day before the release notes deadline===
+* Send a reminder on the  [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel. Reply to a thread of the previous reminder, but select to also send to to channel.
+===Day after the release notes deadline===
+* Review the draft release notes document.
+* Create a new release in Nucleus for Desktop, Android, and iOS.
+* Copy release notes from the draft release notes document.
+** Order the release notes via the ''sort num'', the order will be from highest number to lowest. Otherwise, the default order is based when the release notes were added to the release.
+** Group items that belong to a category together. For example, items with WebRTC can be grouped together.
+* Set the relnote tracking flag to XXX+
+* Share a link to the staged Release Notes on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel.
+{| class="wikitable"
+|-
+| NNN.0 Release notes are now available on the staging server.
+If there are any wording suggestions or last minute additions, please reply to this thread.
+* ''link to staging Desktop relesae notes''
+* ''link to staging Android relesae notes''
+* ''link to staging iOS relesae notes''
+|}
+* When available adds links to security advisories and developer documentation.
+== Dot-Release Notes ==
 There are a few specifics to release notes for a dot-release.
-Example: [https://www.mozilla.org/firefox/102.0.1/releasenotes/ 102.0.1 release notes]
+===During dot release preperation===
-* Notes do have the bug number indicated (and linked to) between parentheses at the end.
+* Evaluate if an uplift requires a release note
+* Create a release in Nuclues.
+** Add the release notes. Inlcude the bug number indicated (and linked to) between parentheses at the end.
 * Put a link to the reference release notes for the major version e.g.: Reference link to [https://www.mozilla.org/firefox/102.0/releasenotes/ 102.0 release notes].
+* Time permiting share a link to the staged Release Notes on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel.
+== Known Issues ==
+For some defects reported post-release go-live, it should be evaluated if it is useful to add a known issue to the release notes.
+* Update the release notes to add a Known Issue.
+** Include a link to the bug that is tracking the issue.
+** If there are multiple releases on the same version include the Known Issue in the release and all dot release versions.
+* After a fix for the issue has been released, edit the Known Issue:
+** Format the release note text to strikethrough
+** Append the text with information in bracket that includes the version that released the fix, for example “(Fixed in 120.0.1)”
 == Style Guide ==
@@ Line 93: / Line 175: @@
 * Don't link to bugs in the finalized release notes.
 ** NOTE:  Include links to bugs in dot release notes.
-* Group items that belong to a category together. For example, items with WebRTC can be grouped together.
 * Use full stops at the end of every note. The MDN [https://developer.mozilla.org/docs/MDN/Writing_guidelines/Writing_style_guide#writing_style Writing Style] is a good reference to follow for capitalization, contractions, numbers and numerals, pluralization, apostrophes and quotation marks, commas, hyphens, and spelling.
@@ Line 99: / Line 180: @@
 Release notes are written and managed in [https://nucleus.mozilla.org Nucleus].
-=== Nucleus and mozilla.org ===
 The release notes page on mozilla.org for a specific version will not be available while the is_public flag is not selected in Nucleus but it will be available on the staging instance of mozilla.org (www-dev.allizom.org).
@@ Line 111: / Line 191: @@
 Mozilla.org syncs with Nucleus every 15mins, depending on CDN caching it may take up to 25mins for release notes to be available worldwide.
-=== Release notes Categories ===
 In Nucleus you should associate each note with a category. The notes will be grouped by category in the templated page on mozilla.org.