Bug 1497575 - [staging-release] Add some docs for `mach try release`. r=Callek, a=NPOTB
authorTom Prince <mozilla@hocat.ca>
Wed, 17 Oct 2018 20:30:47 +0000
changeset 500835 a74302e0bd3ffda5bb6085fe8958f33c2208aefe
parent 500834 4d53e56a539190350aa5805320d75f787769b6fd
child 500836 9739a3c9c339a4cdf361ff91b26b7f569ab48b1a
push id1864
push userffxbld-merge
push dateMon, 03 Dec 2018 15:51:40 +0000
treeherdermozilla-release@f040763d99ad [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersCallek, NPOTB
bugs1497575
milestone64.0
Bug 1497575 - [staging-release] Add some docs for `mach try release`. r=Callek, a=NPOTB Differential Revision: https://phabricator.services.mozilla.com/D8768
tools/tryselect/docs/selectors/index.rst
tools/tryselect/docs/selectors/release.rst
--- a/tools/tryselect/docs/selectors/index.rst
+++ b/tools/tryselect/docs/selectors/index.rst
@@ -6,16 +6,17 @@ These are the currently implemented try 
 * :doc:`fuzzy <fuzzy>`: Select tasks using a fuzzy finding algorithm and
   a terminal interface.
 * :doc:`again <again>`: Re-run a previous ``try_task_config.json`` based
   push.
 * :doc:`empty <empty>`: Don't select any tasks. Taskcluster will still run
   some tasks automatically (like lint and python unittest tasks). Further tasks
   can be chosen with treeherder's ``Add New Jobs`` feature.
 * :doc:`syntax <syntax>`: Select tasks using classic try syntax.
+* :doc:`release <release>`: Prepare a tree for doing a staging release.
 
 You can run them with:
 
 .. code-block:: shell
 
     $ mach try <selector>
 
 See selector specific options by running:
@@ -27,8 +28,9 @@ See selector specific options by running
 .. toctree::
   :caption: Available Selectors
   :maxdepth: 1
   :hidden:
 
   Fuzzy <fuzzy>
   Empty <empty>
   Syntax <syntax>
+  Release <release>
new file mode 100644
--- /dev/null
+++ b/tools/tryselect/docs/selectors/release.rst
@@ -0,0 +1,27 @@
+Release Selector
+================
+
+This command configures the tree in preparation for doing a staging release,
+and pushes the result to try. The changes that that are made include:
+
+- Updating the version number.
+- Applying the migrations that are done as part of merge day.
+- Disabling repacking most locales. (This can be disabled by passing ``--no-limit-locales``).
+
+For staging a beta release, run the following (with an appropriate version number):
+
+.. code-block:: shell
+
+    $ mach try release --version 64.0b5 --migration central-to-beta
+
+For staging a final release (rc or patch), run the following (with an appropriate version number)
+
+.. code-block:: shell
+
+    $ mach try release --version 64.0 --migration central-to-beta --migration beta-to-release
+
+Once the decision task is on the push is complete, you can start the release
+through `staging ship-it instance <https://shipit.staging.mozilla-releng.net/new>`_\ [#shipit]_.
+
+
+.. [#shipit] This is only available to release engineering and release management (as of 2018-10-15).