diff options
| author | Nicolas Patry <patry.nicolas@protonmail.com> | 2023-07-26 18:06:31 +0200 |
|---|---|---|
| committer | Nicolas Patry <patry.nicolas@protonmail.com> | 2023-07-26 18:06:31 +0200 |
| commit | 834e1b197b4959aa3c011b9a5d5af1ace3e98c42 (patch) | |
| tree | 1c3165642ef2ce207689dcc0a0e3b9dd61c5c0b5 /.github | |
| parent | 1235aa25360081607ccb2795a934a675868ce9ba (diff) | |
| download | candle-834e1b197b4959aa3c011b9a5d5af1ace3e98c42.tar.gz candle-834e1b197b4959aa3c011b9a5d5af1ace3e98c42.tar.bz2 candle-834e1b197b4959aa3c011b9a5d5af1ace3e98c42.zip | |
Adding a documentation book.
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/book-cd.yml | 41 | ||||
| -rw-r--r-- | .github/workflows/book.yml | 29 |
2 files changed, 70 insertions, 0 deletions
diff --git a/.github/workflows/book-cd.yml b/.github/workflows/book-cd.yml new file mode 100644 index 00000000..5bef4475 --- /dev/null +++ b/.github/workflows/book-cd.yml @@ -0,0 +1,41 @@ +name: Deploy +on: + pull-request: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-latest + permissions: + contents: write # To push a branch + pull-requests: write # To create a PR from that branch + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Install latest mdbook + run: | + tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name') + url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz" + mkdir mdbook + curl -sSL $url | tar -xz --directory=./mdbook + echo `pwd`/mdbook >> $GITHUB_PATH + - name: Deploy GitHub Pages + run: | + # This assumes your book is in the root of your repository. + # Just add a `cd` here if you need to change to another directory. + cd candle-book + mdbook build + git worktree add gh-pages + git config user.name "Deploy from CI" + git config user.email "" + cd gh-pages + # Delete the ref to avoid keeping history. + git update-ref -d refs/heads/gh-pages + rm -rf * + mv ../book/* . + git add . + git commit -m "Deploy $GITHUB_SHA to gh-pages" + git push --force --set-upstream origin gh-pages diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml new file mode 100644 index 00000000..895a68db --- /dev/null +++ b/.github/workflows/book.yml @@ -0,0 +1,29 @@ +name: CI +on: + pull_request: + +jobs: + test: + name: Test candle-book + runs-on: ubuntu-latest + permissions: + contents: write # To push a branch + pull-requests: write # To create a PR from that branch + steps: + - uses: actions/checkout@master + - name: Install Rust + run: | + rustup set profile minimal + rustup toolchain install stable + rustup default stable + - name: Install latest mdbook + run: | + tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name') + url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz" + mkdir bin + curl -sSL $url | tar -xz --directory=bin + echo "$(pwd)/bin" >> $GITHUB_PATH + - name: Run tests + run: cd candle-book && mdbook test + + |