diff options
| author | ᵗᵃᶻʸ <gardendistrict0x0@outlook.com> | 2026-04-16 17:12:45 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-04-16 17:12:45 +1000 |
| commit | 056996cf5914978a7a0051d11bf5bc4570705fa8 (patch) | |
| tree | eb53ecd8223df9ccd842dc5efc35ae09e261b95d /.github/workflows | |
| parent | fbcd528390d1e49cc4ea5474b0c45f4fe5e96859 (diff) | |
feat(ci/cd): Specify docs directory in mdBook build and add CNAME
Diffstat (limited to '.github/workflows')
| -rw-r--r-- | .github/workflows/mdbook.yml | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml new file mode 100644 index 0000000..28d5e36 --- /dev/null +++ b/.github/workflows/mdbook.yml @@ -0,0 +1,62 @@ +# Sample workflow for building and deploying a mdBook site to GitHub Pages +# +# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html +# +name: Deploy mdBook site to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["master"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + env: + MDBOOK_VERSION: 0.4.36 + steps: + - uses: actions/checkout@v4 + - name: Install mdBook + run: | + curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh + rustup update + cargo install --version ${MDBOOK_VERSION} mdbook + - name: Setup Pages + id: pages + uses: actions/configure-pages@v5 + - name: Build with mdBook + run: mdbook build docs + - name: Add CNAME + run: echo "tinyff.tazy.dev" > docs/book/CNAME + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/book + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v5 |
