-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Add CI check to ensure that rustdoc JSON FORMAT_VERSION
is correctly updated
#142677
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
base: master
Are you sure you want to change the base?
Add CI check to ensure that rustdoc JSON FORMAT_VERSION
is correctly updated
#142677
Conversation
|
Could this be a tidy check instead? It's better to have these things in one centralized place in Rust, rather than scattered around in random bash scripts. |
I guess? Didn't even realize that I could do the same in rust much more easily. ^^' |
This comment has been minimized.
This comment has been minimized.
23e5243
to
5d9e058
Compare
Moved it to |
Oh also: r? @Kobzol |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess it could also work locally, but it's always a PITA to figure out a diff vs master, so this is fine. Could you please try to break the CI job in this PR to see if it works on PR CI?
5d9e058
to
43d18cf
Compare
rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing |
Looks like the check didn't run, hmm. Probably adding some logging before the |
It's because |
76cea70
to
122cf96
Compare
This comment has been minimized.
This comment has been minimized.
122cf96
to
c352ab5
Compare
Follow-up of #142601.
Tested it locally with:
BASE_COMMIT=1bb335244c311a07cee165c28c553c869e6f64a9 src/ci/docker/host-x86_64/mingw-check-1/validate-rustdoc-json-format-version-update.sh
(whereBASE_COMMIT
value was the commit before I made a wrong change with theFORMAT_VERSION
update).This is a first version. I plan to send a follow-up to also ensure that
FORMAT_VERSION
is updated if any code change is done inrustdoc-json-types
. For that I just need to check that a line not starting with/
and not an empty line was updated. Fun times withgrep
ahead. :')cc @aDotInTheVoid
r? @nnethercote