feat: Promote modifications to public API (#2339) #5522
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: publish distributions | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - v* | |
| pull_request: | |
| branches: | |
| - main | |
| - release/v* | |
| release: | |
| types: [published] | |
| # Run weekly at 1:23 UTC | |
| schedule: | |
| - cron: '23 1 * * 0' | |
| workflow_dispatch: | |
| inputs: | |
| publish: | |
| type: choice | |
| description: 'Publish to TestPyPI?' | |
| options: | |
| - false | |
| - true | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| name: Build Python distribution | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| - name: Install python-build and twine | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install build twine | |
| python -m pip list | |
| - name: Build a sdist and wheel | |
| if: github.event_name != 'schedule' | |
| run: | | |
| python -m build . | |
| - name: Build a sdist and wheel and check for warnings | |
| if: github.event_name == 'schedule' | |
| run: | | |
| PYTHONWARNINGS=error,default::DeprecationWarning python -m build . | |
| - name: Verify untagged commits have dev versions | |
| if: "!startsWith(github.ref, 'refs/tags/')" | |
| run: | | |
| latest_tag=$(git describe --tags) | |
| latest_tag_revlist_SHA=$(git rev-list -n 1 ${latest_tag}) | |
| main_SHA="$(git rev-parse --verify origin/main)" | |
| wheel_name=$(find dist/ -iname "*.whl" -printf "%f\n") | |
| if [[ "${latest_tag_revlist_SHA}" != "${main_SHA}" ]]; then # don't check main push events coming from tags | |
| if [[ "${wheel_name}" == *"pyhf-0.1.dev"* || "${wheel_name}" != *"dev"* ]]; then | |
| echo "python-build incorrectly named built distribution: ${wheel_name}" | |
| echo "python-build is lacking the history and tags required to determine version number" | |
| echo "intentionally erroring with 'return 1' now" | |
| return 1 | |
| fi | |
| else | |
| echo "Push event to origin/main was triggered by push of tag ${latest_tag}" | |
| fi | |
| echo "python-build named built distribution: ${wheel_name}" | |
| - name: Verify tagged commits don't have dev versions | |
| if: startsWith(github.ref, 'refs/tags') | |
| run: | | |
| wheel_name=$(find dist/ -iname "*.whl" -printf "%f\n") | |
| if [[ "${wheel_name}" == *"dev"* ]]; then | |
| echo "python-build incorrectly named built distribution: ${wheel_name}" | |
| echo "this is incorrrectly being treated as a dev release" | |
| echo "intentionally erroring with 'return 1' now" | |
| return 1 | |
| fi | |
| echo "python-build named built distribution: ${wheel_name}" | |
| - name: Verify the distribution | |
| run: twine check --strict dist/* | |
| - name: List contents of sdist | |
| run: python -m tarfile --list dist/pyhf-*.tar.gz | |
| - name: List contents of wheel | |
| run: python -m zipfile --list dist/pyhf-*.whl | |
| - name: Upload distribution artifact | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: dist-artifact | |
| path: dist | |
| publish: | |
| name: Publish Python distribution to (Test)PyPI | |
| if: github.event_name != 'pull_request' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| # Mandatory for publishing with a trusted publisher | |
| # c.f. https://docs.pypi.org/trusted-publishers/using-a-publisher/ | |
| permissions: | |
| id-token: write | |
| # Restrict to the environment set for the trusted publisher | |
| environment: | |
| name: publish-package | |
| steps: | |
| - name: Download distribution artifact | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: dist-artifact | |
| path: dist | |
| - name: List all files | |
| run: ls -lh dist | |
| - name: Publish distribution 📦 to Test PyPI | |
| # Publish to TestPyPI on tag events of if manually triggered | |
| # Compare to 'true' string as booleans get turned into strings in the console | |
| if: >- | |
| (github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'scikit-hep/pyhf') | |
| || (github.event_name == 'workflow_dispatch' && github.event.inputs.publish == 'true' && github.repository == 'scikit-hep/pyhf') | |
| uses: pypa/[email protected] | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| print-hash: true | |
| - name: Publish distribution 📦 to PyPI | |
| if: github.event_name == 'release' && github.event.action == 'published' && github.repository == 'scikit-hep/pyhf' | |
| uses: pypa/[email protected] | |
| with: | |
| print-hash: true |