s3s/.github/workflows/docs.yml at 3e41f2fe22d616d4816dae647c30c17b7b9f34c9 · s3s-project/s3s · GitHub

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
name: Docs

on:
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - uses: dtolnay/rust-toolchain@nightly
      - uses: Swatinem/rust-cache@v2
      - name: Build documentation
        run: RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --no-deps --all-features
      - name: Add index redirect
        run: echo '<meta http-equiv="refresh" content="0; url=s3s">' > target/doc/index.html
      - name: Add .nojekyll file
        run: touch target/doc/.nojekyll
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v4
        with:
          path: ./target/doc

  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@v4