-
Notifications
You must be signed in to change notification settings - Fork 943
ci(deploy-docs): install mdbook
with install-action
#4157
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
Conversation
Maybe it could also be used here: rustup/.github/workflows/ci.yaml Lines 1525 to 1529 in 3fc52e9
And here: rustup/ci/actions-templates/test-docs-template.yaml Lines 15 to 19 in 3fc52e9
|
@ChrisDenton Thanks for pointing that out! I actually think these two jobs should be merged so these books can be tested on PR using the same workflow. I'll try to do that and delete this job... |
57738cf
to
ee6ce61
Compare
ee6ce61
to
cc5a8b5
Compare
cc5a8b5
to
7c10c10
Compare
FWIW, I do not recommend doing this without pinning to a specific version. It is not unusual that new releases break things, and it's best to test new versions and look at how it renders before updating. (Fortunately the rustup book is pretty basic, so problems are less likely, but I still wouldn't recommend it.) |
@ehuss Thanks for the feedback! I have a question about this though: When making this PR I thought, at least for me, it would be the best if we use the same version for local preview (I use the Are we supposed to use like a one-year-old PS: Pinning the version would simply be two extra lines in this new setup, I've done this before. |
Yea, it's a bit tricky to test locally with the exact same version that is used in this repo. Generally my workflow is:
Or if you have an automated update (like with renovatebot):
So, you can generally stay on the latest version of mdbook (particularly with renovatebot), but the actual transition happens through a PR, not implicitly when new versions are published. It's tough to say exactly what kinds of breakage might happen. Some past examples might be rust-lang/mdBook#2482, rust-lang/mdBook#2479, rust-lang/mdBook#2473, rust-lang/mdBook#2383, rust-lang/mdBook#2472, rust-lang/mdBook#1949, rust-lang/mdBook#1743, rust-lang/mdBook#1235, etc. There have also been issues with these third-party installers having problems or bugs or bad interactions or assumptions with how the releases are structured. |
This PR uses the
install-action
to installmdbook
, giving us access to the new features and/or fixes from the upstream.We're already depending on the very same action to install
taplo
:rustup/ci/actions-templates/centos-fmt-clippy-template.yaml
Lines 68 to 71 in 3fc52e9