forky 0.2.0

Rust Utilities
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

# Github Setup:
# 1. settings > pages > branch > main/docs
# 2. settings > actions > general > workflow permissions > read and write permissions
name: 🌍 Deploy Book
on:
  push:
    branches: main
    paths: ['docs/**','.github/workflows/book.yml']
jobs:
  deploy:
    name: Build and Deploy
    runs-on: ubuntu-20.04
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
    steps:
      - name: 📂 Checkout
        uses: actions/checkout@v4
      - name: 📂 Cache
        uses: actions/cache@v3
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
      - name: 🔨 Install mdbook
        uses: peaceiris/actions-mdbook@v1
        with:
          mdbook-version: '0.4.34'
      - name: 🔨 Install mdbook-mermaid
        uses: baptiste0928/cargo-install@v2
        with:
          crate: mdbook-mermaid
          version: '0.12.6'
      - name: 🔨 Build Book
        run: mdbook build
        working-directory: ./docs
      - name: 🌍 Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: ${{ github.ref == 'refs/heads/main' }}
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_branch: pages
          publish_dir: ./docs/book
          destination_dir: docs