describe toolstate system#243
Merged
Merged
Conversation
ehuss
reviewed
Aug 1, 2019
Contributor
ehuss
left a comment
There was a problem hiding this 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.)
Member
Author
|
@ehuss added that section, thanks! |
RalfJung
commented
Aug 1, 2019
kennytm
approved these changes
Aug 2, 2019
Member
Author
|
Rebased and added link from infrastructure page. |
Member
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.