Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

describe toolstate system #243

Merged
merged 5 commits into from Aug 6, 2019

Conversation

@RalfJung
Copy link
Member

commented Aug 1, 2019

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

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

@ehuss
Copy link
Contributor

left a comment

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.)

toolstate.md Outdated Show resolved Hide resolved

@RalfJung RalfJung force-pushed the RalfJung:toolstate branch from d51d084 to 8b63a46 Aug 1, 2019

@RalfJung

This comment has been minimized.

Copy link
Member Author

commented Aug 1, 2019

@ehuss added that section, thanks!

toolstate.md Outdated Show resolved Hide resolved
@kennytm
kennytm approved these changes Aug 2, 2019
@ehuss ehuss referenced this pull request Aug 5, 2019

@RalfJung RalfJung force-pushed the RalfJung:toolstate branch from ddbafef to bbc4104 Aug 6, 2019

@RalfJung

This comment has been minimized.

Copy link
Member Author

commented Aug 6, 2019

Rebased and added link from infrastructure page.

@pietroalbini

This comment has been minimized.

Copy link
Member

commented Aug 6, 2019

Thanks!

@pietroalbini pietroalbini merged commit 1c42d39 into rust-lang:master Aug 6, 2019

1 check passed

Travis CI - Pull Request Build Passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.