Skip to content

chore: update README.md #29

chore: update README.md

chore: update README.md #29

Workflow file for this run

name: Forcerelay Guide
on:
push:
branches:
- master
tags:
- v[0-9]+.*
pull_request:
paths:
- guide/**
# Cancel previous runs of this workflow when a new commit is added to the PR, branch or tag
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
guide:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
- name: cache .cargo directory
uses: actions/cache@v1
with:
path: ~/.cargo
key: cargo-dir
restore-keys: |
cargo-dir
- name: Install mdbook
uses: actions-rs/[email protected]
with:
crate: mdbook
version: latest
use-tool-cache: true
- name: Install mdbook-mermaid
uses: actions-rs/[email protected]
with:
crate: mdbook-mermaid
version: latest
use-tool-cache: true
- name: Install mdbook-template
uses: actions-rs/[email protected]
with:
crate: mdbook-template
version: latest
use-tool-cache: true
- name: Install mdbook-toc
uses: actions-rs/[email protected]
with:
crate: mdbook-toc
version: latest
use-tool-cache: true
- name: Build guide
run: |
cd guide
mdbook build
# Only deploy guide when releasing a new version of Forcerelay
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./guide/book