-
Notifications
You must be signed in to change notification settings - Fork 0
70 lines (55 loc) · 1.85 KB
/
docs.yml
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
68
69
70
name: Documentation
on:
push:
branches: [ "main" ]
# 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:
test:
uses: ./.github/workflows/tests.yml
gen-docs:
needs: test
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Check out inertia
uses: actions/checkout@v3
- name: Install Go
uses: actions/setup-go@v4
with:
go-version: '1.19'
- name: Install docs generator
run: go install github.com/johnstarich/go/gopages@latest
- name: Generate documentation
run: >
gopages
-brand-title "inertia"
-brand-description "G-PST Inertia Monitoring Framework Documentation"
-base "/inertia"
-source-link "https://github.com/G-PST/inertia/blob/main/{{.Path}}{{if .Line}}#L{{.Line}}{{end}}"
- name: Fix documentation file permissions
run: |
chmod -c -R +rX "dist/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- name: Setup GitHub Pages
uses: actions/configure-pages@v3
- name: Upload docs directory
uses: actions/upload-pages-artifact@v2
with:
path: "dist"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2