Skip to content

Conversation

@dipikabh
Copy link
Contributor

@dipikabh dipikabh commented Dec 12, 2025

Description

This PR updates the Firefox release note template (follow-up to #42319 (comment)) and a few previous release note files.

  1. In the template file:
    - Added instruction to delete "Removals" if the section is empty.
    - Added section-specific deletion instruction, "Delete entire [section] section if no updates", because we remove the parent section for HTTP, SVG, MathML, Security, etc if they're empty. (It'll be good to have this info in the template rather than having to check our convention every time.)

    • Added "No notable changes." to "Changes for add-on developers" as well since we always keep this section. (We use this label for the core sections for HTML, CSS, and JavaScript that we don't delete.)
    • Reordered sections to follow this sequence:
      • Developer Tools
      • HTML
      • CSS
      • JavaScript
      • HTTP
      • SVG
      • MathML
      • Security
      • APIs
      • WebAssembly
      • WebDriver
  2. In the latest released (146), beta (147), and nightly (148) files, made updates to reflect changes in the template.

  3. In the remaining files:

    • Updated casing in "## Changes for Web developers" to "## Changes for web developers"
    • Updated the placement of the "Developer Tools" section to the top (when present)
    • Removed "Developer Tools" section where it was empty (123)

Motivation

Ordering the technologies/areas in the logical progression, starting with Dev Tools, then core technologies, followed by others

/cc @pepelsbey

@dipikabh dipikabh requested a review from a team as a code owner December 12, 2025 17:55
@dipikabh dipikabh requested review from pepelsbey and removed request for a team December 12, 2025 17:55
@github-actions github-actions bot added Content:Firefox Content in the Mozilla/Firefox subtree system [PR only] Infrastructure and configuration for the project size/m [PR only] 51-500 LoC changed labels Dec 12, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2025

Preview URLs (56 pages)
Flaws (4)

Note! 54 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Mozilla/Firefox/Releases/42
Title: Firefox 42 release notes for developers
Flaw count: 2

  • macros:
    • Macro domxref produces link /en-US/docs/Web/API/Directory which doesn't resolve
    • Macro domxref produces link /en-US/docs/Web/API/Directory/path which doesn't resolve

URL: /en-US/docs/Mozilla/Firefox/Releases/44
Title: Firefox 44 release notes for developers
Flaw count: 2

  • macros:
    • Macro cssxref produces link /en-US/docs/Web/CSS/@page/marks which doesn't resolve
    • Macro domxref produces link /en-US/docs/Web/API/MessageEvent/initMessageEvent which doesn't resolve
External URLs (53)

URL: /en-US/docs/Mozilla/Firefox/Releases/9
Title: Firefox 9 release notes for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/23
Title: Firefox 23 release notes for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/24
Title: Firefox 24 release notes for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/51
Title: Firefox 51 release notes for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/89
Title: Firefox 89 release notes for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/116
Title: Firefox 116 release notes for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/123
Title: Firefox 123 release notes for developers


URL: /en-US/docs/Mozilla/Firefox/Releases/146
Title: Firefox 146 release notes for developers (Stable)

(comment last updated: 2025-12-16 15:59:16)

@dipikabh dipikabh changed the title fix(release-firefox): Reorder sections and add more instruction comments fix(release-firefox): Reorder sections Dec 15, 2025
@dipikabh
Copy link
Contributor Author

@pepelsbey I've removed the comments as discussed (they're not needed because the script automatically handles empty sections).

Copy link
Member

@pepelsbey pepelsbey left a comment

Choose a reason for hiding this comment

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

I see you reordered MathML and SVG, but it was on purpose to have them right after HTML, since they're also markup languages.

Also, there are still many "remove X if empty" comments left that we don't need, as the release script handles removals automatically.

So, the idea is:

  1. All section headings are commented and will be removed automatically if empty, apart from HTML, CSS, and JavaScript.
  2. Only HTML, CSS, and JavaScript sections have "no notable changes" comments that will be uncommented.

We don't need any other comments or changes to the template, apart from adding the DevTools section.

@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Dec 16, 2025
@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Dec 16, 2025
@dipikabh
Copy link
Contributor Author

there are still many "remove X if empty" comments

Oops! I removed them from the template file but missed removing them from 147 and 148 relnote files. All gone now 👍

I see you reordered MathML and SVG, but it was on purpose to have them right after HTML, since they're also markup languages.

Yes, that makes logical sense and I gathered that would have been the reason.
The sequence HTML → CSS → JavaScript → HTTP → SVG/MathML → APIs makes more sense though because it prioritizes the core technologies more prominently at the top.

In fact, I applied the reordering because I assumed that was the sequence we've used historically.
So I checked what we've done in the past. Of all the relnotes that contain MathML or SVG sections (excluding 146 and 147):

  • 7 place them immediately after HTML
  • 54 place them after JavaScript or HTTP

(I just resolved some merge conflicts in 147 and I haven't updated the order in it yet, pending what we decide to do with the sequence.)

@pepelsbey
Copy link
Member

7 place them immediately after HTML
54 place them after JavaScript or HTTP

There was a moment when I started doing this for logical grouping. That's why it doesn't go all the way back and there are only 7 in that order.

I would suggest keeping changes to a minimum, given the plans for this section, and focus on improving the template for the future releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:Firefox Content in the Mozilla/Firefox subtree size/m [PR only] 51-500 LoC changed system [PR only] Infrastructure and configuration for the project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants