-
Notifications
You must be signed in to change notification settings - Fork 1
80 lines (66 loc) · 2.44 KB
/
publish-doc.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
name: Build and publish documentation
on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+' #pattern match
branches:
- main
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub
# Pages. These were copied from workflows generated by the github UI.
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:
build-and-deploy:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
env:
CONDA_SOLVER: libmamba
steps:
- name: Checkout main repository
uses: actions/checkout@v4
#Note: We get all history and tags, so the version detection will always
#be able to yield vx.y.z for the main website:
with:
fetch-depth: 0
#Since we need geant4 for the docs, we use the geant-data cache method from
#condatest.yml, and then update afterwards:
- name: Setup conda environment
uses: ./.github/actions/setup
with:
PYTHON_VERSION: 3.11
USE_MAMBA: true
CACHED_NOARCH_DEF_PY_FILE: ./.github/resources/cached_noarch_definitions.py
CONDA_ENV_FILE : ./.github/resources/conda-setup.yml
- name: Update conda env for docs
#NB: We do NOT add --prune in the next link, since
#conda-setup_extra_for_docs.yml only contains the extra dependencies
run: conda env update --name simplebuild_dgcode --file ./.github/resources/conda-setup_extra_for_docs.yml
- name: Install self
run: python3 -mpip install .
- name: Build documentation
#NB: -W to turn warnings into errors:
#NB: SIMPLEBUILD_GITVERSION_USE_LATEST_VTAG=1 to show vx.y.z on website,
# even if making additional commits (e.g. with updates for workflows).
run: SIMPLEBUILD_GITVERSION_USE_LATEST_VTAG=1 make html SPHINXOPTS="-W"
working-directory: ./doc/
# - name: Setup Pages
# uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './doc/build/html'
# NB: for robustness we do not run "make linkcheck" here, only in test-doc.yml.
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4