Document rustdoc frontend CI checks #2562
Open
+12
−0
Conversation
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
|
Thanks for the PR. If you have write access, feel free to merge this PR if it does not need reviews. You can request a review using |
rustbot
added
the
S-waiting-on-review
|
r? rustc-dev-guide |
|
this seems ok to me. |
|
Please don't put it into the GUI test suite file, it's specifically for |
|
Thanks for the feedback. I've moved the content out of the GUI test suite file and into the main rustdoc.md file instead. Also updated the command to use ./x.py test tidy --extra-checks=js and removed the manual linter instructions as suggested. |
ali90h
changed the title
This comment has been minimized.
This comment has been minimized.
ali90h
force-pushed
the
rustdoc-ci-frontends-note
branch
from
a17f345 to
91f915d
Compare
ali90h
force-pushed
the
rustdoc-ci-frontends-note
branch
from
91f915d to
0380c32
Compare
|
Thanks, @lolbinarycat — I updated the patch per your notes |
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.
Adds a section to the rustdoc overview explaining that ESLint and TypeScript checks run through tidy in CI, not compiletest. Includes the command to run these checks locally.
This helps contributors understand why their local rustdoc tests might pass but CI fails on frontend linting.
Addresses #2364.