-
Notifications
You must be signed in to change notification settings - Fork 2
63 lines (57 loc) · 1.82 KB
/
rustdoc.yml
File metadata and controls
63 lines (57 loc) · 1.82 KB
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
# Workflow for building and deploying rustdoc to pages
name: Deploy rustdoc to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
paths:
- '**/Cargo.toml'
- '**/Cargo.lock'
- '**.rs'
- '.github/workflows/rustdoc.yml'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
env:
CARGO_TERM_COLOR: always
# 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:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Build Documentation
run: cargo doc --all --no-deps
- name: Add Redirect
# From https://dev.to/deciduously/prepare-your-rust-api-docs-for-github-pages-2n5i
run: |
echo "<meta http-equiv=\"refresh\" content=\"0; url=stable_diffusion_bot\">" > target/doc/index.html
- name: Fix permissions
run: |
chmod -c -R +rX "./target/doc/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- name: Upload artifact
uses: actions/upload-pages-artifact@v4
with:
# Upload docs output
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