-
Notifications
You must be signed in to change notification settings - Fork 3
/
action.yml
182 lines (179 loc) · 6.59 KB
/
action.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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# This is a basic workflow that is manually triggered
name: Docs4NIST
description: Deploys Sphinx-built documentation to https://pages.nist.gov
author: Jonathan Guyer
branding:
icon: book
color: blue
inputs:
docs-folder:
description:
The folder containing your sphinx docs.
required: true
default: "docs/"
pages-branch:
description:
The branch linked to your documentation server.
default: 'nist-pages'
pages-url:
description:
URL of web server for served documentation.
default: 'https://pages.nist.gov'
formats:
description:
Type(s) of output desired in addition to html ('pdf', and/or 'epub')
required: false
default: ''
build-html-command:
description:
The command used to build your html documentation.
required: false
default: make html
build-epub-command:
description:
The command used to build your ePUB documentation.
required: false
default: make epub
build-pdf-command:
description:
The command used to build your PDF documentation.
required: false
default: make latexpdf
pre-build-command:
description:
Run before the build command, you can use this to install system level
dependencies, for example with
"apt-get update -y && apt-get install -y perl"
required: false
apt-packages:
description:
List of APT packages to install.
required: false
default: ''
pip-requirements:
description:
The path to the pip requirements file, relative to the root of the
project.
required: false
conda-environment:
description:
The path to the Conda environment file, relative to the root of the
project.
required: false
push-pulls-pages:
description:
Whether the results of pull requests should be pushed to
`pages-branch`.
# Idiot GitHub Actions inputs doesn't support 'type'.
# https://stackoverflow.com/questions/76292948/github-action-boolean-input-with-default-value
default: 'false'
options:
- true
- false
insert-header-footer:
description:
Whether to insert the NIST branding headers and footers
(which are incompatible with sphinx_rtd_theme).
# Idiot GitHub Actions inputs doesn't support 'type'.
# https://stackoverflow.com/questions/76292948/github-action-boolean-input-with-default-value
default: 'true'
options:
- true
- false
runs:
using: "composite"
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
set-safe-directory: /github/workspace
- name: Set env
shell: bash
# In a PR, github.ref_name can be, e.g., `12/merge`,
# which causes downstream grief.
run: |
refname=${{ github.ref_name }}
echo "NTD2D_SANITIZED_REF_NAME=${refname////_}" >> $GITHUB_ENV
pushpages=${{
github.event_name != 'pull_request'
|| (
inputs.push-pulls-pages == 'true'
&& github.event.pull_request.head.repo.full_name == github.repository
)
}}
echo "NTD2D_PUSH_PAGES=${pushpages}" >> $GITHUB_ENV
- name: Symlink current Actions repo
# from https://github.com/orgs/community/discussions/41927#discussioncomment-4655948
# @mbrancato
working-directory: ${{ github.action_path }}
shell: bash
run: ln -fs $(realpath ./) /home/runner/work/_actions/current
- name: Build the docs
id: ntd2d
# from https://github.com/orgs/community/discussions/41927#discussioncomment-4605881
# @mbrancato
# because usnistgov/Docs4NIST/ntd2d@${{ github.action_ref }}
# doesn't work
uses: ./../../_actions/current/ntd2d
with:
docs-folder: ${{ inputs.docs-folder }}
default-branch: ${{ github.event.repository.default_branch }}
pages-branch: ${{ inputs.pages-branch }}
pages-url: ${{ inputs.pages-url }}
formats: ${{ inputs.formats }}
build-html-command: ${{ inputs.build-html-command }}
build-epub-command: ${{ inputs.build-epub-command }}
build-pdf-command: ${{ inputs.build-pdf-command }}
pre-build-command: ${{ inputs.pre-build-command }}
apt-packages: ${{ inputs.apt-packages }}
pip-requirements: ${{ inputs.pip-requirements }}
conda-environment: ${{ inputs.conda-environment }}
insert-header-footer: ${{ inputs.insert-header-footer }}
- name: Change ownership
shell: bash
run: |
sudo chown -R runner:docker __nist-pages
if: >-
env.NTD2D_PUSH_PAGES == 'true'
&& ( success() || steps.build-html.conclusion == 'success' )
- name: Push changes
uses: ad-m/github-push-action@master
with:
branch: ${{ inputs.pages-branch }}
directory: __nist-pages
github_token: ${{ github.token }}
# Pull requests from forked repos don't have permissions
# to push back to pages-branch
# https://github.com/orgs/community/discussions/26829
if: >-
env.NTD2D_PUSH_PAGES == 'true'
&& (success() || steps.build-html.conclusion == 'success')
- uses: actions/upload-artifact@v3
name: Upload Documentation Artifacts
with:
name: ${{ github.event.repository.name }}-${{ env.NTD2D_SANITIZED_REF_NAME }}-${{ github.sha }}
path: |
${{ steps.ntd2d.outputs.borged-build-folder }}/html
# Use always() to always run this step to publish documentation
# artifacts even when there are failures
if: ${{ always() }}
- uses: actions/upload-artifact@v3
name: Upload Documentation Artifacts
with:
name: ${{ github.event.repository.name }}-${{ env.NTD2D_SANITIZED_REF_NAME }}-${{ github.sha }}
path: |
${{ steps.ntd2d.outputs.borged-build-folder }}/epub/*.epub
# Use always() to always run this step to publish documentation
# artifacts even when there are failures
if: ${{ contains(inputs.formats, 'epub') && always() }}
- uses: actions/upload-artifact@v3
name: Upload Documentation Artifacts
with:
name: ${{ github.event.repository.name }}-${{ env.NTD2D_SANITIZED_REF_NAME }}-${{ github.sha }}
path: |
${{ steps.ntd2d.outputs.borged-build-folder }}/latex/${{ github.event.repository.name }}.pdf
${{ steps.ntd2d.outputs.borged-build-folder }}/latex/${{ github.event.repository.name }}.log
${{ steps.ntd2d.outputs.borged-build-folder }}/latex/${{ github.event.repository.name }}.tex
# Use always() to always run this step to publish documentation
# artifacts even when there are failures
if: ${{ contains(inputs.formats, 'pdf') && always() }}