Update rustdoc workflow to deploy docs with GitHub Actions #358
Conversation
This file contains 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
Deploy generated Rust API documentation to GitHub Pages using the new GitHub Actions deployment model instead of the `gh-pages` branch deployment model: - https://github.blog/2022-08-10-github-pages-now-uses-actions-by-default/ - https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/ This approach follows the model in the `hugo` starter workflow: - https://github.com/actions/starter-workflows/blob/edae9e95bf1c84aff6e1d34afcb7bde9288d0e25/pages/hugo.yml Most updates in the workflow are to model it after the starter workflow template. There are additional changes to Rust toolchain setup: - Enforce nightly toolchain with the `RUSTUP_TOOLCHAIN` env variable which has high priority per https://rust-lang.github.io/rustup/overrides.html. - Remove `rustup default nightly` command. - No longer remove `rust-toolchain` file since `RUSTUP_TOOLCHAIN` has higher priority. - Print out rustdoc verbose version with `rustdoc -Vv`. Because generated docs are no longer stored in git, the workaround to remove docs for large generated Rust sources is no longer required and is removed. `peaceiris/actions-gh-pages` is no longer used to deploy the docs.
|
I don't like how the deploy step shows up as a skipped job. closing this to find another approach. I think I'll merge the docs compile checks into the CI workflow and simplify the rustdoc workflow so it only runs on |
lopopolo
added
S-wip
lopopolo
added
the
A-github-actions
|
This feature landed in the GitHub terraform provider: integrations/terraform-provider-github#1663 |
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.
Deploy generated Rust API documentation to GitHub Pages using the new GitHub Actions deployment model instead of the
gh-pagesbranch deployment model:This approach follows the model in the
hugostarter workflow:Most updates in the workflow are to model it after the starter workflow template. There are additional changes to Rust toolchain setup:
RUSTUP_TOOLCHAINenv variable which has high priority per https://rust-lang.github.io/rustup/overrides.html.rustup default nightlycommand.rust-toolchainfile sinceRUSTUP_TOOLCHAINhas higher priority.rustdoc -Vv.Because generated docs are no longer stored in git, the workaround to remove docs for large generated Rust sources is no longer required and is removed.
peaceiris/actions-gh-pagesis no longer used to deploy the docs.