-
-
Notifications
You must be signed in to change notification settings - Fork 6
89 lines (69 loc) · 2.02 KB
/
build-dev-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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
name: Dev Docs
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:
concurrency:
group: docs-deploy
env:
FORCE_COLOR: "1"
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
# Fetch all history for applying timestamps to every page
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Ensure latest pip
run: python -m pip install --upgrade pip
- name: Install Hatch & pre-commit
run: pip install --upgrade --pre hatch hatch-vcs pre-commit
- name: Initialise default environment
run: hatch run python --version
- name: Configure Git for GitHub Actions bot
run: |
git config --local user.name 'github-actions[bot]'
git config --local user.email 'github-actions[bot]@users.noreply.github.com'
- name: Build documentation
run: hatch run docs:build-check
- name: Commit documentation on gh-pages
run: hatch run docs:ci-build dev
- name: Create archive
run: git archive -o site.zip gh-pages
- uses: actions/upload-artifact@v3
with:
name: docs
path: site.zip
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs:
- build
steps:
- name: Download archive
uses: actions/download-artifact@v3
with:
name: docs
- name: Unpack archive
run: python -m zipfile -e site.zip site
- uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: site
commit_message: ${{ github.event.head_commit.message }}
# Write .nojekyll at the root, see:
# https://help.github.com/en/github/working-with-github-pages/about-github-pages#static-site-generators
enable_jekyll: false
# Only deploy if there were changes
allow_empty_commit: false