Update Github Workflow and release version to 5.5.0 #2
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow will upload a Python Package to PyPI when a release is created | |
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries | |
# This workflow uses actions that are not certified by GitHub. | |
# They are provided by a third-party and are governed by | |
# separate terms of service, privacy policy, and support | |
# documentation. | |
## References: | |
# 1. https://github.com/actions/create-release | |
# 2. https://github.com/ArjanCodes/bragir/blob/main/.github/workflows/release.yaml | |
name: Upload Python Package | |
on: | |
push: | |
tags: | |
- "[0-9]+.[0-9]+.[0-9]+" | |
- "[0-9]+.[0-9]+.[0-9]+a[0-9]+" | |
- "[0-9]+.[0-9]+.[0-9]+b[0-9]+" | |
- "[0-9]+.[0-9]+.[0-9]+rc[0-9]+" | |
permissions: | |
contents: read | |
env: | |
PACKAGE_NAME: "wfx-common-tools" | |
jobs: | |
check-tag-details: | |
runs-on: ubuntu-latest | |
outputs: | |
new_version: ${{ steps.release.outputs.new_version }} | |
suffix: ${{ steps.release.outputs.suffix }} | |
tag_name: ${{ steps.release.outputs.tag_name }} | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Extract tag details | |
id: release | |
run: | | |
if [ "${{ github.ref_type }}" = "tag" ]; then | |
TAG_NAME=${GITHUB_REF#refs/tags/} | |
NEW_VERSION=$(echo $TAG_NAME | awk -F'-' '{print $1}') | |
SUFFIX=$(echo $TAG_NAME | grep -oP '[a-z]+[0-9]+' || echo "") | |
echo "new_version=$NEW_VERSION" >> "$GITHUB_OUTPUT" | |
echo "suffix=$SUFFIX" >> "$GITHUB_OUTPUT" | |
echo "tag_name=$TAG_NAME" >> "$GITHUB_OUTPUT" | |
echo "Version is $NEW_VERSION" | |
echo "Suffix is $SUFFIX" | |
echo "Tag name is $TAG_NAME" | |
else | |
echo "No tag found" | |
exit 1 | |
fi | |
check-version-pypi: | |
needs: check-tag-details | |
runs-on: ubuntu-latest | |
steps: | |
- name: Fetch information from PyPI | |
run: | | |
response=$(curl -s https://pypi.org/pypi/${{ env.PACKAGE_NAME }}/json || echo "{}") | |
latest_previous_version=$(echo $response | grep -o '"[0-9]\+\.[0-9]\+\.[0-9]"' | sort -V | tail -n 1) | |
if [ -z "$latest_previous_version" ]; then | |
echo "Package not found on PyPI." | |
latest_previous_version="0.0.0" | |
fi | |
echo "Latest version on PyPI: $latest_previous_version" | |
echo "latest_previous_version=$latest_previous_version" >> $GITHUB_ENV | |
- name: Compare versions and exit if not newer | |
run: | | |
NEW_VERSION=${{ needs.check-tag-details.outputs.new_version }} | |
LATEST_VERSION=$latest_previous_version | |
if [ "$(printf '%s\n' "$LATEST_VERSION" "$NEW_VERSION" | sort -rV | head -n 1)" != "$NEW_VERSION" ] || [ "$NEW_VERSION" == "$LATEST_VERSION" ]; then | |
echo "The new version $NEW_VERSION is not greater than the latest version $LATEST_VERSION on PyPI." | |
exit 1 | |
else | |
echo "The new version $NEW_VERSION is greater than the latest version $LATEST_VERSION on PyPI." | |
fi | |
release-build: | |
needs: [check-tag-details, check-version-pypi] | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: "3.9" | |
- name: Build release distributions | |
run: | | |
# NOTE: put your own distribution build steps here. | |
python -m pip install build | |
python -m build | |
- name: Upload distributions | |
uses: actions/upload-artifact@v4 | |
with: | |
name: release-dists | |
path: dist/ | |
- name: Create Github Release | |
id: create_release | |
uses: actions/create-release@v1 | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token | |
with: | |
tag_name: ${{github.ref}} | |
generate_release_notes : true | |
pypi-publish: | |
runs-on: ubuntu-latest | |
needs: | |
- release-build | |
permissions: | |
# IMPORTANT: this permission is mandatory for trusted publishing | |
id-token: write | |
# Dedicated environments with protections for publishing are strongly recommended. | |
# For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules | |
environment: | |
name: release | |
# OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status: | |
# url: https://pypi.org/p/YOURPROJECT | |
# | |
# ALTERNATIVE: if your GitHub Release name is the PyPI project version string | |
# ALTERNATIVE: exactly, uncomment the following line instead: | |
# url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }} | |
steps: | |
- name: Retrieve release distributions | |
uses: actions/download-artifact@v4 | |
with: | |
name: release-dists | |
path: dist/ | |
- name: Publish release distributions to PyPI | |
uses: pypa/gh-action-pypi-publish@release/v1 | |
with: | |
packages-dir: dist/ |