Skip to content

Isolate package build and publish #137

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

Draft
hugovk wants to merge 4 commits into
base: master
Choose a base branch
from
+74 −51
Draft

Isolate package build and publish #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb5d52e
Isolate package build and publish
hugovk Apr 24, 2026
623a92b
Remove old tox publishing env
hugovk Apr 24, 2026
8308d1d
Ignore pre-existing 'W002: Wheel contains duplicate files'
hugovk Apr 24, 2026
b015568
Remove redundant lines
hugovk Apr 25, 2026
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
108 changes: 70 additions & 38 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This workflow is triggered two ways:
#
# 1. When a tag is created, the workflow will upload the package to
# 1. When a commit is made, the workflow will upload the package to
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I won't be able to do releases in one PR now, right? It'll require me to do two.

Copy link
Copy Markdown
Member Author

@hugovk hugovk Apr 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please could you explain your current release process?

https://github.com/python/tzdata/blob/master/docs/maintaining.rst#making-a-release doesn't mention PRs.

That says:

  • Push a tag -> publishes to Test PyPI.
  • Create a GH release -> publishes to PyPI.

Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Apr 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Push a tag -> publishes to Test PyPI.

I can push a tag for a commit in a PR, as long as it's from a branch in this repository (which is what the bot does).

# test.pypi.org.
# 2. When a release is made, the workflow will upload the package to pypi.org.
#
Expand All @@ -9,49 +9,81 @@
name: Upload package

on:
release:
types: [created]
push:
tags:
- '*'
pull_request:
release:
types:
- published
workflow_dispatch:

permissions:
contents: read

env:
FORCE_COLOR: 1

jobs:
deploy:
build-package:
name: Build & verify package
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false

- uses: hynek/build-and-inspect-python-package@fe0a0fb1925ca263d076ca4f2c13e93a6e92a33e # v2.17.0

# Publish to Test PyPI on every commit on main.
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't this fail due to duplicate version numbers?

Copy link
Copy Markdown
Member Author

@hugovk hugovk Apr 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. As mentioned, blurb uses hatch-vcs so dev versions are like 2.0.1.dev37 and will change based on the number of commits since the last tag. So it's not a problem there.

Will have to rethink this!

Copy link
Copy Markdown
Member Author

@hugovk hugovk Apr 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think changing the if: guard to pushed tags would work?

Then we can still test the package build works when not publishing. And only publish for tags (Test PyPI) and releases (prod PyPI).

release-test-pypi:
name: Publish in-dev package to test.pypi.org
if: |
github.repository_owner == 'python'
&& github.event_name == 'push'
&& github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
needs: build-package

permissions:
id-token: write

steps:
- name: Download packages built by build-and-inspect-python-package
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
with:
name: Packages
path: dist

- name: Publish to Test PyPI
uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
with:
repository-url: https://test.pypi.org/legacy/

release-pypi:
name: Publish to PyPI
# Only run for published releases.
if: |
github.repository_owner == 'python'
&& github.event.action == 'published'
runs-on: ubuntu-latest
needs: build-package

environment:
name: release
url: https://pypi.org/p/tzdata
url: >-
https://pypi.org/project/tzdata/${{
github.event.release.tag_name
}}

permissions:
id-token: write

steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -U tox
- name: Create tox environments
run: |
tox -p -e py,build --notest
- name: Run tests
run: |
tox -e py
- name: Build package
run: |
tox -e build
- name: Publish package (TestPyPI)
if: github.event_name == 'push'
uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
with:
repository-url: https://test.pypi.org/legacy/
verbose: true
- name: Publish package
if: github.event_name == 'release'
uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
with:
verbose: true
- name: Download packages built by build-and-inspect-python-package
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
with:
name: Packages
path: dist

- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b # v1.14.0
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
runs-on: "ubuntu-latest"
strategy:
matrix:
toxenv: ["build", "precommit", "typing", "docs"]
toxenv: ["precommit", "typing", "docs"]
env:
TOXENV: ${{ matrix.toxenv }}

Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
requires = ["setuptools>=40.8.0", "wheel"]
build-backend = "setuptools.build_meta"

[tool.check-wheel-contents]
ignore = ["W002"]

[tool.isort]
atomic=true
force_grid_wrap=0
Expand Down
12 changes: 0 additions & 12 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,15 +70,3 @@ deps =
commands =
sphinx-build -d "{toxworkdir}/docs_doctree" "{toxinidir}/docs" \
"{toxinidir}/docs/_output" {posargs: -j auto --color -bhtml}

[testenv:build]
description = Build a wheel and source distribution
skip_install = True
deps =
build
twine
commands =
python -c "from pathlib import Path; \
[x.unlink(missing_ok=True) for x in Path('{toxinidir}/dist').glob('*')]"
python -m build -o {toxinidir}/dist {toxinidir}
twine check {toxinidir}/dist/*
Loading