-
Notifications
You must be signed in to change notification settings - Fork 1
172 lines (153 loc) · 7.52 KB
/
Copy pathDocumentation2.yml
File metadata and controls
172 lines (153 loc) · 7.52 KB
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
name: Generate Documentation
on:
push:
release:
types: [published]
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write # release changes require contents write
steps:
- uses: actions/checkout@v4
#- run: ls ../../
- run: ls ../
#- run: ls ../CPWP-2023-TurbineCode
- run: ls
- name: Run Doxygen
uses: mattnotmitt/doxygen-action@v1
with:
# Path to Doxyfile
doxyfile-path: ./docs/config/Doxyfile
# Working directory
#working-directory: doxygen
- name: "Get Commit SHA Short"
# See: https://stackoverflow.com/questions/58886293/getting-current-branch-and-commit-hash-in-github-action
# See: https://github.com/Shippable/support/issues/3530
run: echo "GITHUB_SHA_SHORT=$(echo $GITHUB_SHA | cut -c 1-6)" >> $GITHUB_ENV
- name: Upload HTML as Artifact
uses: actions/upload-artifact@v4
with:
# Name of the artifact to upload.
# Optional. Default is 'artifact'
# See: https://github.com/orgs/community/discussions/26965
# See: https://github.com/orgs/community/discussions/26370
name: "Doxygen-${{github.run_number}}_HTML-Documentation_${{github.event_name}}-${{github.ref_name}}_Commit-${{env.GITHUB_SHA_SHORT}}"
# A file, directory or wildcard pattern that describes what to upload
# Required.
path: ./docs/doxygen-out/html
# The desired behavior if no files are found using the provided path.
# Available Options:
# warn: Output a warning but do not fail the action
# error: Fail the action with an error message
# ignore: Do not output any warnings or errors, the action does not fail
# Optional. Default is 'warn'
if-no-files-found: error
# Duration after which artifact will expire in days. 0 means using default retention.
# Minimum 1 day.
# Maximum 90 days unless changed from the repository settings page.
# Optional. Defaults to repository settings.
retention-days: 0
# The level of compression for Zlib to be applied to the artifact archive.
# The value can range from 0 to 9.
# For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
# Optional. Default is '6'
# compression-level:
# If true, an artifact with a matching name will be deleted before a new one is uploaded.
# If false, the action will fail if an artifact for the given name already exists.
# Does not fail if the artifact does not exist.
# Optional. Default is 'false'
overwrite: true
- name: Attach HTML to Release
if: github.event_name == 'release' && success() || failure()
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
echo DEBUG - github.event_name = ${{github.event_name}}
echo DEBUG - github.ref = ${{ github.ref }}
echo DEBUG - github.ref_name = ${{github.ref_name}}
cd ./docs/doxygen-out
ls
ls ../../
zip -r ../../CPWP-2025-26_Load_HTML_Documentation_${{github.event_name}}-${{github.ref_name}}_Commit-${{env.GITHUB_SHA_SHORT}}.zip ./html
ls ../../
gh release upload ${{github.ref_name}} ../../CPWP-2025-26_Load_HTML_Documentation_${{github.event_name}}-${{github.ref_name}}_Commit-${{env.GITHUB_SHA_SHORT}}.zip
- name: Upload RTF as Artifact
uses: actions/upload-artifact@v4
with:
# Name of the artifact to upload.
# Optional. Default is 'artifact'
name: "Doxygen-${{github.run_number}}_RTF-Documentation_${{github.event_name}}-${{github.ref_name}}_Commit-${{env.GITHUB_SHA_SHORT}}"
# A file, directory or wildcard pattern that describes what to upload
# Required.
path: ./docs/doxygen-out/rtf
# The desired behavior if no files are found using the provided path.
# Available Options:
# warn: Output a warning but do not fail the action
# error: Fail the action with an error message
# ignore: Do not output any warnings or errors, the action does not fail
# Optional. Default is 'warn'
if-no-files-found: error
# Duration after which artifact will expire in days. 0 means using default retention.
# Minimum 1 day.
# Maximum 90 days unless changed from the repository settings page.
# Optional. Defaults to repository settings.
retention-days: 0
# The level of compression for Zlib to be applied to the artifact archive.
# The value can range from 0 to 9.
# For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
# Optional. Default is '6'
# compression-level:
# If true, an artifact with a matching name will be deleted before a new one is uploaded.
# If false, the action will fail if an artifact for the given name already exists.
# Does not fail if the artifact does not exist.
# Optional. Default is 'false'
overwrite: true
- name: Attach RTF to Release
if: github.event_name == 'release' && success() || failure()
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
cd ./docs/doxygen-out
ls
ls ../../
zip -r ../../CPWP-2025-26_Load_RTF_Documentation_${{github.event_name}}-${{github.ref_name}}_Commit-${{env.GITHUB_SHA_SHORT}}.zip ./rtf
ls ../../
gh release upload ${{github.ref_name}} ../../CPWP-2025-26_Load_RTF_Documentation_${{github.event_name}}-${{github.ref_name}}_Commit-${{env.GITHUB_SHA_SHORT}}.zip
- run: mkdir pdf_output
- run: ls
#- run: ls ./docs
#- run: ls ./docs/doxygen-out/latex
#- run: make -f ./docs/latex/Makefile
- name: Upload PDF as Artifact
uses: actions/upload-artifact@v4
with:
# Name of the artifact to upload.
# Optional. Default is 'artifact'
name: "Doxygen-${{github.run_number}}_PDF-Documentation_${{github.event_name}}-${{github.ref_name}}_Commit-${{env.GITHUB_SHA_SHORT}}"
# A file, directory or wildcard pattern that describes what to upload
# Required.
path: pdf_output
# The desired behavior if no files are found using the provided path.
# Available Options:
# warn: Output a warning but do not fail the action
# error: Fail the action with an error message
# ignore: Do not output any warnings or errors, the action does not fail
# Optional. Default is 'warn'
if-no-files-found: warn
# Duration after which artifact will expire in days. 0 means using default retention.
# Minimum 1 day.
# Maximum 90 days unless changed from the repository settings page.
# Optional. Defaults to repository settings.
retention-days: 0
# The level of compression for Zlib to be applied to the artifact archive.
# The value can range from 0 to 9.
# For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
# Optional. Default is '6'
# compression-level:
# If true, an artifact with a matching name will be deleted before a new one is uploaded.
# If false, the action will fail if an artifact for the given name already exists.
# Does not fail if the artifact does not exist.
# Optional. Default is 'false'
overwrite: true