Book: CD to Github page #742
Open
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
To allow for easy redirection to the repo from the book
Needs to select "Github action" here: https://github.com/kraktus/criterion.rs/settings/pages I based myself on mdbook CD wiki: https://github.com/rust-lang/mdBook/wiki/Automated-Deployment:-GitHub-Actions This action will deploy the book whenever the master branch is updated. This can lead to slight differences between the book and the crate, if the book is updated before new crate version is released, but on the other will allow fixing typos and other issues easily.
kraktus
added a commit
to kraktus/mdbook-linkcheck
that referenced
this pull request
Nov 10, 2023
Adapted from the bash snippet at the top of the README, needed it for bheisler/criterion.rs#742.
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.
close #677
see d71f090 for technical details.
The current issue is that its posting the book at
https://bheisler.github.io/criterion.rs/instead ofhttps://bheisler.github.io/criterion.rs/book/index.htmland I'm not sure how it'd plays with the master doc. before trying to fix this, I want to be sure the idea of CD for the book is validated.In fact considering the "master" documentation still displays 0.3.4 and has not been updated for 2 years I think it'd be safe to scrape it and only serve the book: https://bheisler.github.io/criterion.rs/criterion/