File tree 1 file changed +12
-21
lines changed
1 file changed +12
-21
lines changed Original file line number Diff line number Diff line change 8
8
branches :
9
9
- main
10
10
11
+ permissions :
12
+ contents : write
13
+
11
14
jobs :
12
- build-docs :
13
- runs-on : ubuntu-latest
14
- steps :
15
- - uses : actions/checkout@v4
16
- - name : Set up Python and dependencies
17
- uses : ./.github/actions/python-deps
18
- with :
19
- pythonVersion : " 3.11"
20
- - name : Build documentation
21
- run : mkdocs build
22
- - name : Archive built documentation
23
- uses : actions/upload-artifact@v4
24
- with :
25
- name : docs
26
- path : public/docs
27
15
deploy-docs :
28
16
runs-on : ubuntu-latest
29
17
name : Deploy documentation to GitHub Pages
30
18
# publish on 'main' only to prevent version clutter
31
19
if : ${{ github.ref == 'refs/heads/main' }}
32
- needs : [build-docs]
33
20
steps :
34
21
- uses : actions/checkout@v4
35
22
- name : Set up Python and dependencies
36
23
uses : ./.github/actions/python-deps
37
24
with :
38
25
pythonVersion : " 3.11"
39
- - name : Restore built docs from artifacts
40
- uses : actions/download-artifact@v4
26
+ - name : Build pre-release documentation
27
+ run : mkdocs build
28
+ - name : Archive built documentation
29
+ uses : actions/upload-artifact@v4
41
30
with :
42
31
name : docs
43
32
path : public/docs
44
- - name : Publish documentation
33
+ - name : Deploy pre-release documentation
34
+ if : ${{ github.ref_name == 'main'}}
45
35
uses : ./.github/actions/mike-docs
46
36
with :
47
- version : ${{ github.event.release.tag_name }}
48
- alias : latest
37
+ version : development
38
+ pre_release : true # include pre-release notification banner
39
+ push : true
You can’t perform that action at this time.
0 commit comments