release #30
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
| name: release | |
| # This workflow will build a Python package and publish it to PyPI when a new tag is created. | |
| # | |
| # Usage: | |
| # - Create a new tag with the version number in the format v*.*.* where * are single digit numbers | |
| # - Push the tag to the repository with git push --tags | |
| # | |
| # Result: | |
| # - The workflow will check if the new version is greater than the latest version on PyPI | |
| # - The workflow will build the package and publish it to PyPI | |
| # - The workflow will also create a GitHub release with the tag name and the release notes | |
| # Checklist for using this workflow up for a new project: | |
| # - In this file: | |
| # - Replace guitares with the name of your package | |
| # - Replace 3.10 with the version of Python you want to use | |
| # - In github settings: | |
| # - Create an environment called `release` and setup the permissions (https://github.com/<ORGANIZATION>/<REPO_NAME>/settings/environments) | |
| # - On PyPi: | |
| # - Create the project and add a trusted publisher (https://pypi.org/manage/project/<PACKAGE_NAME>/settings/publishing/) | |
| # - Ensure the publisher is configured to use: | |
| # - environment name: `release` (can be changed, but should be the one created in the github settings) | |
| # - the name of this workflow yml (in this case: publish-to-pypi.yml) | |
| # | |
| on: | |
| push: | |
| tags: | |
| - "v[0-9]+.[0-9]+.[0-9]+" | |
| - "v[0-9]+.[0-9]+.[0-9]+a[0-9]+" | |
| - "v[0-9]+.[0-9]+.[0-9]+b[0-9]+" | |
| - "v[0-9]+.[0-9]+.[0-9]+rc[0-9]+" | |
| env: | |
| PACKAGE_NAME: "guitares" | |
| PYTHON_VERSION: "3.10" | |
| jobs: | |
| 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 and 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_pypi: | |
| needs: 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 | jq --raw-output "select(.releases != null) | .releases | keys_unsorted | last") | |
| 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.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 | |
| setup_and_build: | |
| needs: [details, check_pypi] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Install Build tools | |
| run: pip install --upgrade build pip setuptools | |
| - name: Install dependencies | |
| run: | |
| pip install . | |
| - name: Build source and wheel distribution | |
| run: | | |
| python -m build | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: dist | |
| path: dist/ | |
| pypi_publish: | |
| name: Upload release to PyPI | |
| needs: [setup_and_build, details] | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: release | |
| permissions: | |
| id-token: write | |
| steps: | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - name: Publish distribution to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| github_release: | |
| name: Create GitHub Release | |
| needs: [setup_and_build, details] | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: dist | |
| path: dist/ | |
| - name: Create GitHub Release | |
| id: create_release | |
| env: | |
| GH_TOKEN: ${{ github.token }} | |
| run: | | |
| gh release create ${{ needs.details.outputs.tag_name }} dist/* --title ${{ needs.details.outputs.tag_name }} --generate-notes |