deps-lsp/.github/workflows/docs.yml at 3fcf2f86eb18a1a7df1bbd7c07e5bc3ad7c7dedb · bug-ops/deps-lsp · 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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
name: Documentation

on:
  push:
    branches: [main]
    paths:
      - '**/*.rs'
      - '**/Cargo.toml'
      - '.github/workflows/docs.yml'
  pull_request:
    paths:
      - '**/*.rs'
      - '**/Cargo.toml'

permissions:
  contents: write

env:
  CARGO_TERM_COLOR: always

jobs:
  build-docs:
    name: Build Documentation
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - uses: actions/checkout@v4

      - name: Install Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Cache Cargo
        uses: Swatinem/rust-cache@v2
        with:
          shared-key: "docs"

      - name: Build documentation
        run: cargo doc --workspace --no-deps --all-features
        env:
          RUSTDOCFLAGS: "--cfg docsrs -D warnings"

      - name: Add redirect index.html
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        run: |
          cat > target/doc/index.html <<EOF
          <!DOCTYPE html>
          <html>
            <head>
              <meta charset="utf-8">
              <meta http-equiv="refresh" content="0; url=deps_lsp/index.html">
              <title>Redirecting to deps_lsp</title>
            </head>
            <body>
              <p>Redirecting to <a href="deps_lsp/index.html">deps_lsp documentation</a>...</p>
            </body>
          </html>
          EOF

      - name: Deploy to GitHub Pages
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./target/doc
          force_orphan: true
          user_name: 'github-actions[bot]'
          user_email: 'github-actions[bot]@users.noreply.github.com'