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.

Sign up for GitHub

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

Jump to bottom

Book: CD to Github page #742

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Book: CD to Github page #742

wants to merge 2 commits into from

Commits on Nov 10, 2023

  1. include criterion repo link in book 

    To allow for easy redirection to the repo from the book
    @kraktus
    kraktus committed Nov 10, 2023
    Configuration menu
    Copy the full SHA
    032c978 View commit details
    Browse the repository at this point in the history

  2. Book: CD to Github page 

    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
    kraktus committed Nov 10, 2023
    Configuration menu
    Copy the full SHA
    d71f090 View commit details
    Browse the repository at this point in the history