1
+ # ---------------------------------------------------------------------------------------
2
+ # @parent : github workflow
3
+ # @desc : publish release to github
4
+ # @author : Aetherinox
5
+ # @url : https://github.com/Aetherinox
6
+ # ---------------------------------------------------------------------------------------
7
+
1
8
name : " 📦 Publish › Snippets"
2
9
run-name : " 📦 Publish › Snippets"
3
10
11
+ # ---------------------------------------------------------------------------------------
12
+ # triggers
13
+ # ---------------------------------------------------------------------------------------
14
+
4
15
on :
5
16
workflow_dispatch :
6
17
inputs :
63
74
type : string
64
75
default : " 1"
65
76
77
+ # ---------------------------------------------------------------------------------------
78
+ # jobs
79
+ # ---------------------------------------------------------------------------------------
80
+
66
81
jobs :
67
82
68
83
# ---------------------------------------------------------------------------------------
@@ -74,12 +89,16 @@ jobs:
74
89
📦 Publish › Initialize
75
90
runs-on : ubuntu-latest
76
91
outputs :
77
- package_version : ${{ steps.task_initialize_package_getversion .outputs.PACKAGE_VERSION }}
92
+ package_version : ${{ steps.task_initialize_package_version .outputs.PACKAGE_VERSION }}
78
93
permissions :
79
94
contents : write
80
95
packages : write
81
96
steps :
82
97
98
+ # ---------------------------------------------------------------------------------------
99
+ # Job > Initialize > Start
100
+ # ---------------------------------------------------------------------------------------
101
+
83
102
- name : " ✅ Start"
84
103
id : task_initialize_start
85
104
run : |
@@ -96,19 +115,24 @@ jobs:
96
115
fetch-depth : 0
97
116
98
117
# ---------------------------------------------------------------------------------------
118
+ # Package Version > Set
99
119
# Get version from package.json VERSION value
100
120
# ---------------------------------------------------------------------------------------
101
121
102
- - name : " 👁️🗨️ Get Package Version"
103
- id : task_initialize_package_getversion
122
+ - name : " 👁️🗨️ Package Version › Get "
123
+ id : task_initialize_package_version
104
124
run : |
105
125
VER=$(cat package.json | jq -r '.version')
106
126
echo "PACKAGE_VERSION=$VER" >> $GITHUB_OUTPUT
107
127
108
- - name : " 👁️🗨️ Get Package Version › Print"
109
- id : task_initialize_package_getversion_debug
128
+ # ---------------------------------------------------------------------------------------
129
+ # Package Version > Print (Debug)
130
+ # ---------------------------------------------------------------------------------------
131
+
132
+ - name : " 👁️🗨️ Package Version › Print"
133
+ id : task_initialize_package_version_print
110
134
run : |
111
- echo "VERSION: ${{ steps.task_initialize_package_getversion .outputs.PACKAGE_VERSION }}"
135
+ echo "VERSION: ${{ steps.task_initialize_package_version .outputs.PACKAGE_VERSION }}"
112
136
113
137
# ---------------------------------------------------------------------------------------
114
138
# Job > Release > Github
@@ -164,21 +188,25 @@ jobs:
164
188
npm run obs:generate
165
189
166
190
# ---------------------------------------------------------------------------------------
167
- # Get guid and uuid from env variable
168
- # generated by npm
191
+ # .ENV > Get
192
+ # Get guid and uuid from env variable generated by npm
169
193
# ---------------------------------------------------------------------------------------
170
194
171
195
- name : " 🪪 .ENV › Get"
172
196
id : task_release_dotenv_get
173
197
uses : falti/dotenv-action@v1
174
198
199
+ # ---------------------------------------------------------------------------------------
200
+ # .ENV > Print (Debug)
201
+ # Show guid and uuid from env variable generated by npm
202
+ # ---------------------------------------------------------------------------------------
203
+
175
204
- name : " 🪪 .ENV › Read"
176
205
id : task_dotenv_debug_print
177
206
run : |
178
207
echo "GUID: ${{ steps.task_release_dotenv_get.outputs.GUID }}"
179
208
echo "UUID: ${{ steps.task_release_dotenv_get.outputs.UUID }}"
180
209
181
-
182
210
# ---------------------------------------------------------------------------------------
183
211
# Build Project & Create Zip
184
212
# ---------------------------------------------------------------------------------------
@@ -193,7 +221,7 @@ jobs:
193
221
env :
194
222
NODE_AUTH_TOKEN : ${{ secrets.ADMINSERV_TOKEN_CL }}
195
223
196
- - name : " 🔨 Build › Release Candidate ( ${{ inputs.PLUGIN_NAME }}-${{ env.PACKAGE_VERSION }}-rc.${{ inputs.VERSION_RC }}.zip )"
224
+ - name : " 🔨 Build › RC ( ${{ inputs.PLUGIN_NAME }}-${{ env.PACKAGE_VERSION }}-rc.${{ inputs.VERSION_RC }}.zip )"
197
225
id : task_release_build_rc
198
226
if : ${{ startsWith( inputs.PRERELEASE, true ) }}
199
227
run : |
@@ -223,6 +251,8 @@ jobs:
223
251
224
252
# ---------------------------------------------------------------------------------------
225
253
# [ Tag ]: Confirm
254
+ #
255
+ # check if tag already exists
226
256
# ---------------------------------------------------------------------------------------
227
257
228
258
- name : " 🔖 Tag › Confirm ${{ env.PACKAGE_VERSION }}"
@@ -232,7 +262,7 @@ jobs:
232
262
echo "Tag already present: ${{ steps.task_release_tag_create.outputs.tag_exists }}"
233
263
234
264
# ---------------------------------------------------------------------------------------
235
- # [ Release Candidate ]: Checksum
265
+ # Checksum > Generate
236
266
# ---------------------------------------------------------------------------------------
237
267
238
268
- name : " 🆔 Checksum › Stable"
@@ -245,7 +275,7 @@ jobs:
245
275
echo "FILE_ZIP=${filename_zip}" >> $GITHUB_ENV
246
276
echo "SHA256SUM=${sha256}" >> $GITHUB_ENV
247
277
248
- - name : " 🆔 Checksum › Release Candidate "
278
+ - name : " 🆔 Checksum › RC "
249
279
id : task_release_checksum_rc_set
250
280
if : ${{ startsWith( inputs.PRERELEASE, true ) }}
251
281
run : |
@@ -255,6 +285,10 @@ jobs:
255
285
echo "FILE_ZIP=${filename_zip}" >> $GITHUB_ENV
256
286
echo "SHA256SUM=${sha256}" >> $GITHUB_ENV
257
287
288
+ # ---------------------------------------------------------------------------------------
289
+ # Checksum > Print
290
+ # ---------------------------------------------------------------------------------------
291
+
258
292
- name : " 🆔 Checksum › Print"
259
293
id : task_release_checksum_st_get
260
294
run : |
@@ -273,7 +307,7 @@ jobs:
273
307
avatarSize : 42
274
308
275
309
# ---------------------------------------------------------------------------------------
276
- # [ ZIP ] : Stable
310
+ # Checksum > Add to ZIP file
277
311
# ---------------------------------------------------------------------------------------
278
312
279
313
- name : " 📦 Zip › Add Checksum › Stable"
@@ -284,7 +318,7 @@ jobs:
284
318
zip -jr ${{ inputs.PLUGIN_NAME }}-${{ env.PACKAGE_VERSION }}.zip SHA256SUMS.txt
285
319
ls
286
320
287
- - name : " 📦 Zip › Add Checksum › Release Candidate "
321
+ - name : " 📦 Zip › Add Checksum › RC "
288
322
id : task_release_zip_rc
289
323
if : ${{ startsWith( inputs.PRERELEASE, true ) }}
290
324
run : |
@@ -293,7 +327,7 @@ jobs:
293
327
ls
294
328
295
329
# ---------------------------------------------------------------------------------------
296
- # Generate Changelog
330
+ # Changelog > Generate
297
331
#
298
332
# generates a changelog from the github api. requires a PREVIOUS_TAG in order to figure
299
333
# out the changes made between the two versions.
@@ -323,7 +357,7 @@ jobs:
323
357
fetchViaCommits : true
324
358
configurationJson : |
325
359
{
326
- "template": "## Release Info <sup>(${{ steps.task_release_dotenv_get.outputs.UUID }})</sup>\n- <sub>**Version began on**: <sub>........</sub>`#{{FROM_TAG_DATE}}`</sub>\n- <sub>**SHA256**: <sub>................................</sub>`${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}`</sub>\n- <sub>**GUID**: <sub>.......................................</sub>`${{ steps.task_release_dotenv_get.outputs.GUID }}`</sub>\n- <sub>**UUID**: <sub>.......................................</sub>`${{ steps.task_release_dotenv_get.outputs.UUID }}`</sub>\n- <sub>**Stamp**: <sub>....................................</sub>`#{{FROM_TAG}}-#{{FROM_TAG_DATE}} 🔺 #{{TO_TAG}}-#{{TO_TAG_DATE}}`</sub>\n- <sub>**Last Release**: <sub>......................</sub>`#{{DAYS_SINCE}} days ago`</sub>\n\n<br>\n\n---\n\n<br>\n\n### What's New\nThis release contains the following changes:\n\n<br>\n\n---\n\n<br>\n\n### Statistics\nHow the files have changed:\n<ul><li><a href='#{{RELEASE_DIFF}}'>Changed files</a> : <b>#{{CHANGED_FILES}}</b> </li><li>Commits : <b>#{{COMMITS}}</b> </li><li>Additions : <b>#{{ADDITIONS}}</b></li><li>Deletions : <b>#{{DELETIONS}}</b></li>\n<br />\n</ul>\n\n<br>\n\n---\n\n<br>\n\n### Pull Requests\nThis release is associated with the following pull requests:\n#{{CHANGELOG}}\n\n<br>\n\n---\n\n<br>\n\n"
360
+ "template": "## Release Info <sup>(${{ steps.task_release_dotenv_get.outputs.UUID }})</sup>\n| Item | Value |\n| --- | --- |\n|<sub>SHA256</sub>|<sub>${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}</sub>|\n|<sub>GUID</sub>|<sub>`${{ steps.task_release_dotenv_get.outputs.GUID }}`</sub>|\n|<sub>UUID</sub>|<sub>`${{ steps.task_release_dotenv_get.outputs.UUID }}`</sub>|\n|<sub>Stamp</sub>|<sub>`#{{FROM_TAG}}-#{{FROM_TAG_DATE}} 🔺 #{{TO_TAG}}-#{{TO_TAG_DATE}}`</sub>|\n|<sub>Last Release</sub>|<sub>`#{{DAYS_SINCE}} days ago`</sub>|\n\n<br>\n\n---\n\n<br>\n\n### What's New\nThis release contains the following changes:\n\n<br>\n\n---\n\n<br>\n\n### Statistics\nHow the files have changed:\n<ul><li><a href='#{{RELEASE_DIFF}}'>Changed files</a> : <b>#{{CHANGED_FILES}}</b> </li><li>Commits : <b>#{{COMMITS}}</b> </li><li>Additions : <b>#{{ADDITIONS}}</b></li><li>Deletions : <b>#{{DELETIONS}}</b></li>\n<br />\n</ul>\n\n<br>\n\n---\n\n<br>\n\n### Pull Requests\nThis release is associated with the following pull requests:\n#{{CHANGELOG}}\n\n<br>\n\n---\n\n<br>\n\n"
327
361
}
328
362
env :
329
363
GITHUB_TOKEN : ${{ secrets.ADMINSERV_TOKEN }}
@@ -349,13 +383,13 @@ jobs:
349
383
fetchViaCommits : true
350
384
configurationJson : |
351
385
{
352
- "template": "## Release Info <sup>(${{ steps.task_release_dotenv_get.outputs.UUID }})</sup>\n- <sub>**Version began on**: <sub>........</sub>`#{{FROM_TAG_DATE}}`</sub>\n- <sub>**SHA256**: <sub>................................</sub>`${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}`</sub>\n- <sub>**GUID**: <sub>.......................................</sub>`${{ steps.task_release_dotenv_get.outputs.GUID }}`</sub>\n- <sub>**UUID**: <sub>.......................................</sub>`${{ steps.task_release_dotenv_get.outputs.UUID }}`</sub>\n- <sub>**Stamp**: <sub>....................................</sub>`#{{FROM_TAG}}-#{{FROM_TAG_DATE}} 🔺 #{{TO_TAG}}-#{{TO_TAG_DATE}}`</sub>\n- <sub>**Last Release**: <sub>......................</sub>`#{{DAYS_SINCE}} days ago`\n</sup>\n\n<br>\n\n---\n\n<br>\n\n### What's New\nThis release contains the following changes:\n\n<br>\n\n---\n\n<br>\n\n### Statistics\nHow the files have changed:\n<ul><li><a href='#{{RELEASE_DIFF}}'>Changed files</a> : <b>#{{CHANGED_FILES}}</b> </li><li>Commits : <b>#{{COMMITS}}</b> </li><li>Additions : <b>#{{ADDITIONS}}</b></li><li>Deletions : <b>#{{DELETIONS}}</b></li>\n<br />\n</ul>\n\n<br>\n\n---\n\n<br>\n\n### Commits (#{{UNCATEGORIZED_COUNT}})\nThe following commits are uncategorized:\n#{{UNCATEGORIZED}}\n\n<br>\n\n---\n\n<br>\n\n### Pull Requests\nThis release is associated with the following pull requests:\n#{{CHANGELOG}}\n\n<br>\n\n---\n\n<br>\n\n"
386
+ "template": "## Release Info <sup>(${{ steps.task_release_dotenv_get.outputs.UUID }})</sup>\n| Item | Value |\n| --- | --- |\n|<sub>SHA256</sub>|<sub>${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}</sub>|\n|<sub>GUID</sub>|<sub>`${{ steps.task_release_dotenv_get.outputs.GUID }}`</sub>|\n|<sub>UUID</sub>|<sub>`${{ steps.task_release_dotenv_get.outputs.UUID }}`</sub>|\n|<sub>Stamp</sub>|<sub>`#{{FROM_TAG}}-#{{FROM_TAG_DATE}} 🔺 #{{TO_TAG}}-#{{TO_TAG_DATE}}`</sub>|\n|<sub>Last Release</sub>|<sub>`#{{DAYS_SINCE}} days ago`</sub>|\n\n<br>\n\n---\n\n<br>\n\n### What's New\nThis release contains the following changes:\n\n<br>\n\n---\n\n<br>\n\n### Statistics\nHow the files have changed:\n<ul><li><a href='#{{RELEASE_DIFF}}'>Changed files</a> : <b>#{{CHANGED_FILES}}</b> </li><li>Commits : <b>#{{COMMITS}}</b> </li><li>Additions : <b>#{{ADDITIONS}}</b></li><li>Deletions : <b>#{{DELETIONS}}</b></li>\n<br />\n</ul>\n\n<br>\n\n---\n\n<br>\n\n### Commits (#{{UNCATEGORIZED_COUNT}})\nThe following commits are uncategorized:\n#{{UNCATEGORIZED}}\n\n<br>\n\n---\n\n<br>\n\n### Pull Requests\nThis release is associated with the following pull requests:\n#{{CHANGELOG}}\n\n<br>\n\n---\n\n<br>\n\n"
353
387
}
354
388
env :
355
389
GITHUB_TOKEN : ${{ secrets.ADMINSERV_TOKEN }}
356
390
357
391
# ---------------------------------------------------------------------------------------
358
- # Fetch Changelog
392
+ # Changelog > Fetch
359
393
# ---------------------------------------------------------------------------------------
360
394
361
395
- name : " 📝 Changelog › Print (Categorized)"
@@ -398,7 +432,7 @@ jobs:
398
432
${{ steps.task_release_changelog_categorized.outputs.changelog }}
399
433
${{ steps.task_release_changelog_uncategorized.outputs.changelog }}
400
434
401
- - name : " 🏳️ Post › Release Candidate "
435
+ - name : " 🏳️ Post › RC "
402
436
if : ${{ startsWith( inputs.PRERELEASE, true ) }}
403
437
uses : softprops/action-gh-release@v2
404
438
id : task_release_bundle_rc
0 commit comments