-
Notifications
You must be signed in to change notification settings - Fork 49
72 lines (63 loc) · 2.05 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
71
72
name: Documentation
on:
push:
branches:
- master
paths:
- "**.h"
- "**.hpp"
- "**.dox"
- "**.md"
- "docs/**"
- "**/docs.yml"
- '.github/workflows/docs.yml'
release:
types: [published]
workflow_dispatch:
jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Install dependencies
run: |
sudo apt -y update
sudo apt -y install --no-install-recommends git python3 python3-pip doxygen
sudo -H pip3 install --upgrade poxy
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Prepare repository (on push)
if: ${{ github.event_name == 'push' }}
run: |
git fetch origin ${{ github.ref_name }}:refs/remotes/origin/${{ github.ref_name }} --tags --force
git remote set-head origin -a
git checkout ${{ github.ref_name }}
git pull --force
- name: Prepare repository (on release)
if: ${{ github.event_name == 'release' }}
run: |
git fetch origin master:refs/remotes/origin/master --tags --force
git remote set-head origin -a
git checkout ${{ github.ref_name }}
git pull --force
- name: Prepare repository (on workflow_dispatch)
if: ${{ github.event_name == 'workflow_dispatch' }}
run: |
git fetch origin master:refs/remotes/origin/master --tags --force
git remote set-head origin -a
git checkout ${{ github.ref_name }}
git pull --force
- name: Generate docs
run: |
cd docs
poxy --verbose --git-tags --min-version v2.0.0 --no-squash-patches
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html
keep_files: true
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
commit_message: Update documentation (GitHub actions deploy)