Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Marionette release notes

Quick guide for updating release notes for Marionette on MDN

  1. Check the bugs fixed in release RELEASE: https://bugzilla.mozilla.org/buglist.cgi?j_top=OR&f1=cf_status_firefoxRELEASE&o1=equals&resolution=FIXED&o2=equals&query_format=advanced&f2=cf_status_firefoxRELEASE&v1=fixed&component=Marionette&v2=verified&product=Testing

  2. In this bug list, find the bugs which are relevant for WebDriver users.

  3. If needed, clone the mdn/content repository (https://github.com/mdn/content).

  4. Create a branch for the release, e.g. for Release 91 you might name the branch marionette91.

  5. Open files/en-us/mozilla/firefox/releases/RELEASE/index.html

  6. Write the release notes under WebDriver conformance (Marionette). You can use the following template:

<ul>
  <li>Description 1 ({{bug(BUG_NUMBER_1)}}).</li>
  <li>Description 2 ({{bug(BUG_NUMBER_2)}}).</li>
  ...
  <li>Description N ({{bug(BUG_NUMBER_N)}}).</li>
</ul>

The description should be short and focus on user impact rather than technical details. Refer to existing release notes for wording, brevity, ... https://developer.mozilla.org/en-US/docs/Mozilla/Firefox/Releases/90#webdriver_conformance_marionette

If APIs/features haven been removed, list those under <h4 id="removals_webdriver">Removals</h4>.

  1. Create PR at https://github.com/mdn/content/ (example https://github.com/mdn/content/pull/4322)
The following PR contains all the user facing changes to Marionette for the Firefox 91 release. 
Here a [list of all the changes](https://bugzilla.mozilla.org/buglist.cgi?j_top=OR&f1=cf_status_firefox91&o1=equals&resolution=FIXED&o2=equals&query_format=advanced&f2=cf_status_firefox91&v1=fixed&component=Marionette&v2=verified&product=Testing&).

@whimboo can you please cross-check? Thanks.
  1. After Firefox has been released, send a release message to dev.webdriver once Firefox has been released
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment