Skip to content

describe toolstate system - #243

Merged
emilyalbini merged 5 commits into
rust-lang:masterfrom
RalfJung:toolstate
Aug 6, 2019
Merged

describe toolstate system#243
emilyalbini merged 5 commits into
rust-lang:masterfrom
RalfJung:toolstate

Conversation

@RalfJung

@RalfJungRalfJung commented Aug 1, 2019

Copy link
Copy Markdown
Member

Note that I don't know if the rules I am stating here reflect reality. This is based on about a year of empirical observation of what CI is doing. I tried to get someone to make an authoritative statement by filing rust-lang-nursery/rust-toolstate#3, but that didn't work, so now I am trying the alternative strategy of just saying something and relying on people to correct me if what I say is wrong. ;)

In particular, I am not sure if it is true that all "toolstates" are ignored for releasing nightlies.

Cc @kennytm@pietroalbini

Fixesrust-lang-nursery/rust-toolstate#3. Fixes#235.

@ehussehuss left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks great! I would maybe add a section on how to add a tool, since that has been a point of confusion in the past. Maybe something like this:

## Adding a tool
To add a new tool to be tracked, the following steps must be taken:
1. Create a PR to rust-lang/rust that adds the submodule along with any
necessary build system updates. Be careful that the tests properly support
`--no-fail-fast`.
2. Include changes to [`checktools.sh`]:
- Build the tool at the top. This is the step that actually generates the
JSON status for the tool. When `save-toolstates` is set in
`config.toml`, the rust build system will write a JSON file with the
status of each test.
- Add the tool to `status_check` with whether it should be a beta blocker
or not.
3. Update [`publish_toolstate.py`] to add the tool. This includes a list of
people to ping if the tool is broken, and its source repo. (Note: At the
time of this writing, these users must have permissions to be assignable on
rust-lang/rust GitHub.)
4. Submit a PR to the [toolstate repo] to manually add the tool to the
[`_data/latest.json`] file.
[toolstate repo]: https://github.com/rust-lang-nursery/rust-toolstate/
[`_data/latest.json`]: https://github.com/rust-lang-nursery/rust-toolstate/blob/master/_data/latest.json

(And make the checktools/publish_toolstate links into markdown reference links.)

Comment threadtoolstate.md Outdated
@RalfJung

Copy link
Copy Markdown
MemberAuthor

@ehuss added that section, thanks!

Comment threadtoolstate.md Outdated
@ehussehuss mentioned this pull request Aug 5, 2019
@RalfJung

Copy link
Copy Markdown
MemberAuthor

Rebased and added link from infrastructure page.

@emilyalbini

Copy link
Copy Markdown
Member

Thanks!

@emilyalbini
emilyalbini merged commit 1c42d39 into rust-lang:masterAug 6, 2019
@RalfJung
RalfJung deleted the toolstate branch September 19, 2019 07:35
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cross linking: Document toolstate rules Document toolstate rules

4 participants

@RalfJung@emilyalbini@ehuss@kennytm