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

Automatically generate static file names #107565

Conversation

GuillaumeGomez
Copy link
Member

Based on #107531 so needs it to be merged first.

In #107354, we were able to see that being able to correctly update the static files is not as simple and straight-forward as it could be. So instead of forcing the devs to do the work manually, this PR allows it to be done automatically to prevent such errors to occur again.

r? @notriddle

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 1, 2023
@rustbot
Copy link
Collaborator

rustbot commented Feb 1, 2023

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @Folyd, @jsha

@GuillaumeGomez GuillaumeGomez force-pushed the automatically-generate-static-file-names branch from cbcd7e0 to 26b7738 Compare February 2, 2023 12:26
@GuillaumeGomez
Copy link
Member Author

Rebased so now only the second commit remains.

@notriddle
Copy link
Contributor

I'm not entirely convinced that this is a good idea. It makes updating the font files more convenient, but one workflow I tend to use has me copying the rustdoc.css file into a compiled docroot to test changes to it without having to run the compiler again. This would break that.

Especially since the GUI tests will flag an error if someone fails to update the font files, and tspiteri added a comment explaining how to fix it, I'm not sure if this is all that important.

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Feb 6, 2023

I'm not entirely convinced that this is a good idea. It makes updating the font files more convenient, but one workflow I tend to use has me copying the rustdoc.css file into a compiled docroot to test changes to it without having to run the compiler again. This would break that.

You convinced me with this argument. Let's keep the possibility to copy-paste the file directly. As you mentioned, the CI will fail in any case.

@GuillaumeGomez GuillaumeGomez deleted the automatically-generate-static-file-names branch February 6, 2023 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants