Skip to content

Warn about artifact action behavior for wheel matrices#2040

Merged
webknjaz merged 3 commits intopypa:mainfrom
Herrtian:warn-artifact-v4
May 5, 2026
Merged

Warn about artifact action behavior for wheel matrices#2040
webknjaz merged 3 commits intopypa:mainfrom
Herrtian:warn-artifact-v4

Conversation

@Herrtian
Copy link
Copy Markdown
Contributor

@Herrtian Herrtian commented May 4, 2026

Adds a warning before the artifact upload/download workflow example for people adapting the guide to several platform-specific wheel jobs.

The sample now uses current artifact actions rather than the older v3 versions mentioned in the issue, so this keeps the caution framed around the still-relevant v4+ behavior: don't have multiple wheel jobs upload to the same artifact name; give each job its own artifact and adjust downloads accordingly.

Checks:

  • git diff --check
  • uv run --with pre-commit pre-commit run --files source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst
  • uv run --with nox nox -s build

Fixes #1454


📚 Documentation preview 📚: https://python-packaging-user-guide--2040.org.readthedocs.build/en/2040/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#checking-out-the-project-and-building-distributions

@Herrtian Herrtian requested a review from webknjaz as a code owner May 4, 2026 18:08
@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented May 4, 2026

I think this should be a tip, not a warning. That issue was filed years ago and nobody uses v3. So I don't see why we need to highlight it. Today, I'd rather have a shorter note along the lines of "when building multiple wheels, you'll end up needing using uniquely named artifacts per build job".

@webknjaz webknjaz requested a review from woodruffw May 4, 2026 19:20
@Herrtian
Copy link
Copy Markdown
Contributor Author

Herrtian commented May 5, 2026

Thanks, agreed. I pushed c2b1179 to make this a short tip instead, without the old v3/v4 framing.

Checked locally with git diff --check, file-level pre-commit, and nox -s build.

Copy link
Copy Markdown
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

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

Thanks!

@webknjaz webknjaz enabled auto-merge May 5, 2026 14:59
@webknjaz webknjaz added this pull request to the merge queue May 5, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks May 5, 2026
@webknjaz webknjaz added this pull request to the merge queue May 5, 2026
@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented May 5, 2026

Given https://www.dayswithoutgithubincident.com, it may take a few attempts to merge.

@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks May 5, 2026
@webknjaz webknjaz added this pull request to the merge queue May 5, 2026
@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented May 5, 2026

This one might actually be legit:

/home/runner/work/packaging.python.org/packaging.python.org/source/overview.rst:353: WARNING: unknown document: 'openstack:user/formats'

(though unrelated to the PR)

@webknjaz
Copy link
Copy Markdown
Member

webknjaz commented May 5, 2026

A rerun passed. So it was flaky.

Merged via the queue into pypa:main with commit c9d0b69 May 5, 2026
7 of 8 checks passed
@webknjaz webknjaz added type: enhancement A self-contained enhancement or new feature component: guides diataxis: how-to guide Task oriented directions (https://diataxis.fr/how-to-guides/) labels May 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: guides diataxis: how-to guide Task oriented directions (https://diataxis.fr/how-to-guides/) type: enhancement A self-contained enhancement or new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a caution/warning box about actions/upload-artifact@v4 @ GHA publishing guide

2 participants