diff --git a/.github/workflows/release-pypi.yml b/.github/workflows/release-pypi.yml index 739480a..4a2ff15 100644 --- a/.github/workflows/release-pypi.yml +++ b/.github/workflows/release-pypi.yml @@ -104,15 +104,28 @@ jobs: package_version: ${{ steps.build_package_version.outputs.PACKAGE_VERSION }} package_filename: ${{ steps.build_handle_tarball.outputs.PACKAGE_FILENAME }} steps: + + # --------------------------------------------------------------------------------------- + # Start + # --------------------------------------------------------------------------------------- + - name: "✅ Start" run: | echo "Starting build: ${{ github.event.inputs.OPT_BUILD_METHOD }}" / ${{ inputs.OPT_BUILD_METHOD }} + # --------------------------------------------------------------------------------------- + # Checkout + # --------------------------------------------------------------------------------------- + - name: "☑️ Checkout" uses: actions/checkout@v4 with: fetch-depth: 0 + # --------------------------------------------------------------------------------------- + # Debug > Get Package Version + # --------------------------------------------------------------------------------------- + - name: "👁️‍🗨️ Debug › Get Package Version" id: build_package_version run: | @@ -162,16 +175,28 @@ jobs: PACKAGE=$(find dist/*tar.gz -type f -printf "%f\n") echo "PACKAGE_FILENAME=dist/$PACKAGE" >> $GITHUB_OUTPUT + # --------------------------------------------------------------------------------------- + # Debug > Print Package Info + # --------------------------------------------------------------------------------------- + - name: "👁️‍🗨️ Debug › Print Package Info" id: build_print_package run: | echo ${{ steps.build_package_version.outputs.PACKAGE_VERSION }} echo ${{ steps.build_handle_tarball.outputs.PACKAGE_FILENAME }} + # --------------------------------------------------------------------------------------- + # Twine > Check Dist + # --------------------------------------------------------------------------------------- + - name: "🪢 Twine › Check Dist" run: | twine check dist/* + # --------------------------------------------------------------------------------------- + # Upload Artifact + # --------------------------------------------------------------------------------------- + - name: "📁 Upload › Artifact" uses: actions/upload-artifact@v4 with: @@ -194,14 +219,22 @@ jobs: environment: name: Orion url: https://pypi.org/p/mkdocs-link-embeds-plugin - steps: + + # --------------------------------------------------------------------------------------- + # Pypi Publish (Official) > Download Saved Artifacts + # --------------------------------------------------------------------------------------- + - name: "📁 Download › Saved Artifacts" uses: actions/download-artifact@v4 with: name: python-package-distributions path: dist/ + # --------------------------------------------------------------------------------------- + # Pypi Publish (Official) > Release on Pypi + # --------------------------------------------------------------------------------------- + - name: Release 📦 PyPI Official uses: pypa/gh-action-pypi-publish@release/v1 with: @@ -226,14 +259,22 @@ jobs: environment: name: Orion url: https://test.pypi.org/p/mkdocs-link-embeds-plugin - steps: + + # --------------------------------------------------------------------------------------- + # Pypi Publish (Test) > Download Saved Artifacts + # --------------------------------------------------------------------------------------- + - name: "📁 Download › Saved Artifacts" uses: actions/download-artifact@v4 with: name: python-package-distributions path: dist/ + # --------------------------------------------------------------------------------------- + # Pypi Publish (Test) > Release on Pypi Test Site + # --------------------------------------------------------------------------------------- + - name: Release 📦 PyPI Test uses: pypa/gh-action-pypi-publish@release/v1 with: @@ -252,14 +293,22 @@ jobs: needs: - build runs-on: ubuntu-latest - steps: + + # --------------------------------------------------------------------------------------- + # Pypi Publish (Skip) > Skips Pypi release and goes straight to Github + # --------------------------------------------------------------------------------------- + - name: "📁 Download › Saved Artifacts" uses: actions/download-artifact@v4 with: name: python-package-distributions path: dist/ + # --------------------------------------------------------------------------------------- + # Pypi Publish (Skip) > Skip + # --------------------------------------------------------------------------------------- + - name: "❌ Skip Pypi.org upload" run: | echo "Skipping Pypi.org publish" @@ -398,7 +447,7 @@ jobs: fetchViaCommits: true configurationJson: | { - "template": "## Release Info \n- **Version began on**: ........`#{{FROM_TAG_DATE}}`\n- **SHA256**: ................................`${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}`\n- **Stamp**: ....................................`#{{FROM_TAG}}-#{{FROM_TAG_DATE}} 🔺 #{{TO_TAG}}-#{{TO_TAG_DATE}}`\n- **Last Release**: ......................`#{{DAYS_SINCE}} days ago`\n\n
\n\n---\n\n
\n\n### What's New\nThis release contains the following changes:\n\n
\n\n---\n\n
\n\n### Statistics\nHow the files have changed:\n\n\n
\n\n---\n\n
\n\n### Pull Requests\nThis release is associated with the following pull requests:\n#{{CHANGELOG}}\n\n
\n\n---\n\n
\n\n" + "template": "## Release Info \n| Item | Value |\n| --- | --- |\n|🏷️ Version|${{ env.PACKAGE_VERSION }}|\n|#️⃣ SHA256|${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}|\n|🕟 Stamp|`#{{FROM_TAG}}-#{{FROM_TAG_DATE}} 🔺 #{{TO_TAG}}-#{{TO_TAG_DATE}}`|\n|📅 Last Release|`#{{DAYS_SINCE}} days ago`|\n\n
\n\n---\n\n
\n\n### What's New\nThis release contains the following changes:\n\n
\n\n---\n\n
\n\n### Statistics\nHow the files have changed:\n\n\n
\n\n---\n\n
\n\n### Pull Requests\nThis release is associated with the following pull requests:\n#{{CHANGELOG}}\n\n
\n\n---\n\n
\n\n" } env: GITHUB_TOKEN: ${{ secrets.ADMINSERV_TOKEN }} @@ -424,7 +473,7 @@ jobs: fetchViaCommits: true configurationJson: | { - "template": "## Release Info \n- **Version began on**: ........`#{{FROM_TAG_DATE}}`\n- **SHA256**: ................................`${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}`\n- **Stamp**: ....................................`#{{FROM_TAG}}-#{{FROM_TAG_DATE}} 🔺 #{{TO_TAG}}-#{{TO_TAG_DATE}}`\n- **Last Release**: ......................`#{{DAYS_SINCE}} days ago`\n\n
\n\n---\n\n
\n\n### What's New\nThis release contains the following changes:\n\n
\n\n---\n\n
\n\n### Statistics\nHow the files have changed:\n\n\n
\n\n---\n\n
\n\n### Commits (#{{UNCATEGORIZED_COUNT}})\nThe following commits are uncategorized:\n#{{UNCATEGORIZED}}\n\n
\n\n---\n\n
\n\n### Pull Requests\nThis release is associated with the following pull requests:\n#{{CHANGELOG}}\n\n
\n\n---\n\n
\n\n" + "template": "## Release Info \n| Item | Value |\n| --- | --- |\n|🏷️ Version|${{ env.PACKAGE_VERSION }}|\n|#️⃣ SHA256|${{ env.SHA256SUM }} 🔺 ${{ env.FILE_ZIP }}|\n|🕟 Stamp|`#{{FROM_TAG}}-#{{FROM_TAG_DATE}} 🔺 #{{TO_TAG}}-#{{TO_TAG_DATE}}`|\n|📅 Last Release|`#{{DAYS_SINCE}} days ago`|\n\n
\n\n---\n\n
\n\n### What's New\nThis release contains the following changes:\n\n
\n\n---\n\n
\n\n### Statistics\nHow the files have changed:\n\n\n
\n\n---\n\n
\n\n### Pull Requests\nThis release is associated with the following pull requests:\n#{{CHANGELOG}}\n\n
\n\n" } env: GITHUB_TOKEN: ${{ secrets.ADMINSERV_TOKEN }}