Skip to content

Commit 8847992

Browse files
AetherinoxAetherinox
committed
ci: update workflow pypi
1 parent 0293972 commit 8847992

1 file changed

Lines changed: 54 additions & 5 deletions

File tree

‎.github/workflows/release-pypi.yml‎

Lines changed: 54 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,28 @@ jobs:
104104
package_version: ${{ steps.build_package_version.outputs.PACKAGE_VERSION }}
105105
package_filename: ${{ steps.build_handle_tarball.outputs.PACKAGE_FILENAME }}
106106
steps:
107+
108+
# ---------------------------------------------------------------------------------------
109+
# Start
110+
# ---------------------------------------------------------------------------------------
111+
107112
- name: "✅ Start"
108113
run: |
109114
echo "Starting build: ${{ github.event.inputs.OPT_BUILD_METHOD }}" / ${{ inputs.OPT_BUILD_METHOD }}
110115
116+
# ---------------------------------------------------------------------------------------
117+
# Checkout
118+
# ---------------------------------------------------------------------------------------
119+
111120
- name: "☑️ Checkout"
112121
uses: actions/checkout@v4
113122
with:
114123
fetch-depth: 0
115124

125+
# ---------------------------------------------------------------------------------------
126+
# Debug > Get Package Version
127+
# ---------------------------------------------------------------------------------------
128+
116129
- name: "👁️‍🗨️ Debug › Get Package Version"
117130
id: build_package_version
118131
run: |
@@ -162,16 +175,28 @@ jobs:
162175
PACKAGE=$(find dist/*tar.gz -type f -printf "%f\n")
163176
echo "PACKAGE_FILENAME=dist/$PACKAGE" >> $GITHUB_OUTPUT
164177
178+
# ---------------------------------------------------------------------------------------
179+
# Debug > Print Package Info
180+
# ---------------------------------------------------------------------------------------
181+
165182
- name: "👁️‍🗨️ Debug › Print Package Info"
166183
id: build_print_package
167184
run: |
168185
echo ${{ steps.build_package_version.outputs.PACKAGE_VERSION }}
169186
echo ${{ steps.build_handle_tarball.outputs.PACKAGE_FILENAME }}
170187
188+
# ---------------------------------------------------------------------------------------
189+
# Twine > Check Dist
190+
# ---------------------------------------------------------------------------------------
191+
171192
- name: "🪢 Twine › Check Dist"
172193
run: |
173194
twine check dist/*
174195
196+
# ---------------------------------------------------------------------------------------
197+
# Upload Artifact
198+
# ---------------------------------------------------------------------------------------
199+
175200
- name: "📁 Upload › Artifact"
176201
uses: actions/upload-artifact@v4
177202
with:
@@ -194,14 +219,22 @@ jobs:
194219
environment:
195220
name: Orion
196221
url: https://pypi.org/p/mkdocs-link-embeds-plugin
197-
198222
steps:
223+
224+
# ---------------------------------------------------------------------------------------
225+
# Pypi Publish (Official) > Download Saved Artifacts
226+
# ---------------------------------------------------------------------------------------
227+
199228
- name: "📁 Download › Saved Artifacts"
200229
uses: actions/download-artifact@v4
201230
with:
202231
name: python-package-distributions
203232
path: dist/
204233

234+
# ---------------------------------------------------------------------------------------
235+
# Pypi Publish (Official) > Release on Pypi
236+
# ---------------------------------------------------------------------------------------
237+
205238
- name: Release 📦 PyPI Official
206239
uses: pypa/gh-action-pypi-publish@release/v1
207240
with:
@@ -226,14 +259,22 @@ jobs:
226259
environment:
227260
name: Orion
228261
url: https://test.pypi.org/p/mkdocs-link-embeds-plugin
229-
230262
steps:
263+
264+
# ---------------------------------------------------------------------------------------
265+
# Pypi Publish (Test) > Download Saved Artifacts
266+
# ---------------------------------------------------------------------------------------
267+
231268
- name: "📁 Download › Saved Artifacts"
232269
uses: actions/download-artifact@v4
233270
with:
234271
name: python-package-distributions
235272
path: dist/
236273

274+
# ---------------------------------------------------------------------------------------
275+
# Pypi Publish (Test) > Release on Pypi Test Site
276+
# ---------------------------------------------------------------------------------------
277+
237278
- name: Release 📦 PyPI Test
238279
uses: pypa/gh-action-pypi-publish@release/v1
239280
with:
@@ -252,14 +293,22 @@ jobs:
252293
needs:
253294
- build
254295
runs-on: ubuntu-latest
255-
256296
steps:
297+
298+
# ---------------------------------------------------------------------------------------
299+
# Pypi Publish (Skip) > Skips Pypi release and goes straight to Github
300+
# ---------------------------------------------------------------------------------------
301+
257302
- name: "📁 Download › Saved Artifacts"
258303
uses: actions/download-artifact@v4
259304
with:
260305
name: python-package-distributions
261306
path: dist/
262307

308+
# ---------------------------------------------------------------------------------------
309+
# Pypi Publish (Skip) > Skip
310+
# ---------------------------------------------------------------------------------------
311+
263312
- name: "❌ Skip Pypi.org upload"
264313
run: |
265314
echo "Skipping Pypi.org publish"
@@ -398,7 +447,7 @@ jobs:
398447
fetchViaCommits: true
399448
configurationJson: |
400449
{
401-
"template": "## Release Info \n- <sub>**Version began on**: <sub>........</sub>`#{{FROM_TAG_DATE}}`</sub>\n- <sub>**SHA256**: <sub>................................</sub>`${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}`</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"
450+
"template": "## Release Info \n| Item | Value |\n| --- | --- |\n|<sub>🏷️ Version</sub>|<sub>${{ env.PACKAGE_VERSION }}</sub>|\n|<sub>#️⃣ SHA256</sub>|<sub>${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}</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>Changes : <b>#{{CHANGES}}</b> </li><li>Commits : <b>#{{COMMITS}}</b> </li><li>Additions : <b>#{{ADDITIONS}}</b></li><li>Deletions : <b>#{{DELETIONS}}</b></li><li>PRs (categorized) : <b>#{{CATEGORIZED_COUNT}}</b></li><li>PRs (uncategorized) : <b>#{{UNCATEGORIZED_COUNT}}</b></li><li>PRs (open) : <b>#{{OPEN_COUNT}}</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"
402451
}
403452
env:
404453
GITHUB_TOKEN: ${{ secrets.ADMINSERV_TOKEN }}
@@ -424,7 +473,7 @@ jobs:
424473
fetchViaCommits: true
425474
configurationJson: |
426475
{
427-
"template": "## Release Info \n- <sub>**Version began on**: <sub>........</sub>`#{{FROM_TAG_DATE}}`</sub>\n- <sub>**SHA256**: <sub>................................</sub>`${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}`</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"
476+
"template": "## Release Info \n| Item | Value |\n| --- | --- |\n|<sub>🏷️ Version</sub>|<sub>${{ env.PACKAGE_VERSION }}</sub>|\n|<sub>#️⃣ SHA256</sub>|<sub>${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}</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>Changes : <b>#{{CHANGES}}</b> </li><li>Commits : <b>#{{COMMITS}}</b> </li><li>Additions : <b>#{{ADDITIONS}}</b></li><li>Deletions : <b>#{{DELETIONS}}</b></li><li>PRs (categorized) : <b>#{{CATEGORIZED_COUNT}}</b></li><li>PRs (uncategorized) : <b>#{{UNCATEGORIZED_COUNT}}</b></li><li>PRs (open) : <b>#{{OPEN_COUNT}}</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"
428477
}
429478
env:
430479
GITHUB_TOKEN: ${{ secrets.ADMINSERV_TOKEN }}

0 commit comments

Comments
 (0)