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
name: Docs
on:
push:
branches:
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
name: Build rustdoc
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Build docs
run: cargo doc --no-deps --all-features
env:
RUSTDOCFLAGS: "--cfg docsrs -D warnings"
- name: Add root redirect
run: |
echo '<meta http-equiv="refresh" content="0;url=forensicnomicon/">' \
> target/doc/index.html
- name: Build CLI binary
run: cargo build -p forensicnomicon-cli --release
- name: Generate data.json for search widget
run: |
./target/release/4n6query dump --format json --dataset all \
> target/doc/data.json
- name: Copy static docs
run: |
cp docs/architecture.html target/doc/architecture.html
cp docs/search.html target/doc/search.html
- uses: actions/upload-pages-artifact@v3
with:
path: target/doc
deploy:
name: Deploy to GitHub Pages
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4