Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Document rustdoc frontend CI checks #2562

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

Open
ali90h wants to merge 1 commit into rust-lang:master
base: master
Choose a base branch
Loading
from ali90h:rustdoc-ci-frontends-note

Conversation

Copy link
Contributor

@ali90h ali90h commented Aug 30, 2025 •
edited by rustbot
Loading

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.

Copy link
Collaborator

rustbot commented Aug 30, 2025

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 r? rustc-dev-guide or r? <username>.

@rustbot rustbot added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Aug 30, 2025
Copy link
Contributor Author

ali90h commented Aug 30, 2025

r? rustc-dev-guide

Copy link
Member

jyn514 commented Aug 30, 2025

this seems ok to me.
@GuillaumeGomez @jsha do you have time to review this?

Copy link
Member

fmease commented Aug 30, 2025 •
edited
Loading

Please don't put it into the GUI test suite file, it's specifically for tests/rustdoc-gui/, nothing else. Please keep the separation. This doesn't belong there.
GuillaumeGomez and ali90h reacted with thumbs up emoji

Copy link
Contributor Author

ali90h commented Aug 30, 2025

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 ali90h changed the title (削除) rustdoc: document ESLint/TSC run via tidy in CI; add local reproduce commands (削除ここまで) (追記) Document rustdoc frontend CI checks (追記ここまで) Aug 30, 2025
Copy link
Member

CC @lolbinarycat

lolbinarycat reacted with thumbs up emoji

This comment has been minimized.

@ali90h ali90h force-pushed the rustdoc-ci-frontends-note branch from a17f345 to 91f915d Compare August 31, 2025 06:52
@ali90h ali90h force-pushed the rustdoc-ci-frontends-note branch from 91f915d to 0380c32 Compare August 31, 2025 06:55
Copy link
Contributor Author

ali90h commented Aug 31, 2025

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
Reviewers

@lolbinarycat lolbinarycat lolbinarycat left review comments

@GuillaumeGomez GuillaumeGomez Awaiting requested review from GuillaumeGomez

Labels
S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /