Repository navigation
46 lines (44 loc) · 1.63 KB
/
Copy pathdocs.yml
File metadata and controls
46 lines (44 loc) · 1.63 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
name: Docs
# Community fork: automatic docs deployment is disabled; run manually if needed.
on:
workflow_dispatch:
permissions:
contents: read
jobs:
generate-and-deploy:
name: Generate and deploy
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout head
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0
- name: Setup Go
uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
with:
go-version-file: 'go.mod'
- name: Setup Python
uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
with:
python-version: "3.10"
- name: Generate documentation
run: make docs
- name: Store generated MkDocs site
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
with:
name: mkdocs-site
path: site
retention-days: 7
- name: Setup git user for mike
run: |
git config --global user.name "${{ github.actor }}"
git config --global user.email "${{ github.actor }}@users.noreply.github.com"
- name: Deploy to main
# Update main also on release events to refresh versions in installation instructions
if: ${{ github.ref_name == 'main' || github.event_name == 'release' }}
run: mike deploy --push --title "Unreleased (main)" main
- name: Deploy to latest
if: ${{ github.event_name == 'release' }}
run: mike deploy --push --title "Latest (${{ github.event.release.tag_name }})" latest