Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix automated PyPI publishing #231

Merged
merged 4 commits into from
Oct 25, 2024
Merged

Fix automated PyPI publishing #231

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c76533
remove incorrect 'v' from tag name pattern, we don't use it
ThrawnCA Oct 25, 2024
e940ee5
configure default 'environment' value when publish workflow is triggered
ThrawnCA Oct 25, 2024
9818b61
check that tag value matches Python version before publishing to PyPI
ThrawnCA Oct 25, 2024
f0cbbb1
quote the GitHub publish workflow tag pattern
ThrawnCA Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 21 additions & 11 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
push:
#On versioned releases
tags:
- v*.*.*
- '*.*.*'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
inputs:
Expand Down Expand Up @@ -100,52 +100,62 @@ jobs:
name: Publish Package
runs-on: ubuntu-latest
environment:
name: ${{ github.event.inputs.environment }}
name: ${{ github.event.inputs.environment || 'pypi' }}
url: ${{ steps.version.outputs.url }}
concurrency:
group: ${{ github.event.inputs.environment }}-deployment
cancel-in-progress: false

env:
ENVIRONMENT: ${{ github.event.inputs.environment || 'pypi' }}
steps:
- name: Get Git Tag and set url from environment
id: version
run: |
#!/bin/bash

ENVIRONMENT=$1
TAG_VALUE=${GITHUB_REF/refs\/tags\//}
echo "version=${TAG_VALUE}" >> $GITHUB_ENV

# Extract the repository name (minus the owner/org)
reponame=$(basename $GITHUB_REPOSITORY)
echo "reponame=${reponame}" >> $GITHUB_OUTPUT

if [ "$ENVIRONMENT" == "pypi" ]; then
url="https://pypi.com/p/$reponame"
elif [ "$1" == "testpypi" ]; then

if [ "$env.ENVIRONMENT" == "testpypi" ]; then
url="https://test.pypi.com/p/$reponame"
echo "environment=${env.ENVIRONMENT}" >> $GITHUB_OUTPUT
else
url=""
url="https://pypi.com/p/$reponame"
echo "environment=pypi" >> $GITHUB_OUTPUT
fi

echo "url=${url}" >> $GITHUB_OUTPUT

- name: Checkout repository
uses: actions/checkout@v4

- name: Validate tag version
if: ${{ startsWith(github.ref, 'refs/tags') }}
run: |
PYTHON_VERSION=$(grep "\bversion='[^']+'" | awk -F "'" '{print $2}')
if [ "${steps.version.outputs.version}" != "$PYTHON_VERSION" ]; then
echo "Version mismatch; tag version is [${steps.version.outputs.version}] but Python version is [$PYTHON_VERSION]"
exit 1
fi

- name: Build package ${{ steps.version.outputs.reponame }} @ ${{ steps.version.outputs.version }}
run: |
pip install build
pip install twine
python -m build
- name: Publish package distributions to PyPI
if: ${{ startsWith(github.ref, 'refs/tags') && (github.event.inputs.environment == 'pypi' || github.event.inputs.environment == 'publish' ) && github.event.inputs.dryRun != 'true'}}
if: ${{ startsWith(github.ref, 'refs/tags') && steps.version.outputs.environment == 'pypi' && github.event.inputs.dryRun != 'true' }}
uses: pypa/gh-action-pypi-publish@release/v1
# with:
# skip-existing: true
# verbose: true
# print-hash: true
- name: Test Publish package distributions to PyPI
if: ${{ startsWith(github.ref, 'refs/tags') && github.event.inputs.environment == 'testpypi' && github.event.inputs.dryRun == 'true' }}
if: ${{ startsWith(github.ref, 'refs/tags') && steps.version.outputs.environment == 'testpypi' && github.event.inputs.dryRun == 'true' }}
uses: pypa/gh-action-pypi-publish@release/v1
with:
repository-url: https://test.pypi.org/legacy/
Expand Down