Closed Bug 1397433 Opened 2 years ago Closed 2 years ago

Add in-tree docs for tools/tryselect (aka mach try)

Categories

(Testing :: General, enhancement)

enhancement
Not set

Tracking

(firefox59 fixed)

RESOLVED FIXED
mozilla59
Tracking Status
firefox59 --- fixed

People

(Reporter: ahal, Assigned: ahal)

References

(Blocks 1 open bug)

Details

Attachments

(1 file)

There are a bunch of scattered docs on how to use/push to try server on various wiki pages and on mdn. But nowadays, by far the most recommended way is to use the in-tree |mach try| (whether that's with syntax or fuzzy). We should make the in-tree gecko docs the canonical place where try server docs live. We will be more likely to remember to update it when we modify the tools, and it will be easier to find than a wiki page somewhere.

I think this will be especially important as we add more selectors (in addition to syntax and fuzzy).
Comment on attachment 8935835 [details]
Bug 1397433 - [tryselect] Create in-tree documentation for |mach try|,

https://reviewboard.mozilla.org/r/206706/#review212510

one nit, the rest is great to read- I imagine a few small modifications over time, but what I was looking for was already in here!

::: tools/tryselect/docs/selectors/syntax.rst:50
(Diff revision 1)
> +it isn't always kept up to date. Check the boxes for the tasks you wish to run
> +then copy/paste the computed ``mach try`` command into your terminal.
> +
> +
> +.. _try_option_syntax.py: https://hg.mozilla.org/mozilla-central/file/tip/taskcluster/taskgraph/try_option_syntax.py
> +.. _trychooser: https://www.mozilla.org/en-US/about/governance/policies/commit/access-policy/

shouldn't this be: https://mozilla-releng.net/trychooser/
Attachment #8935835 - Flags: review?(jmaher) → review+
Assignee: nobody → ahalberstadt
Status: NEW → ASSIGNED
Comment on attachment 8935835 [details]
Bug 1397433 - [tryselect] Create in-tree documentation for |mach try|,

https://reviewboard.mozilla.org/r/206706/#review212510

> shouldn't this be: https://mozilla-releng.net/trychooser/

Yes, good catch! I always forget how to do urls so copy/paste them, but forgot to update it.
Pushed by ahalberstadt@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/0aa878a34b6d
[tryselect] Create in-tree documentation for |mach try|, r=jmaher
https://hg.mozilla.org/mozilla-central/rev/0aa878a34b6d
Status: ASSIGNED → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla59
You need to log in before you can comment on or make changes to this bug.