Push for PyPI Trusted Publisher usage #267
Merged
Conversation
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
Add new upload_distribution input to match a new step in the publish distribution job, where the distribution folder is uploaded as an artifact. Add new build_dir input to specify the build target folder for the distribution. Make publish_on_pypi a required input, in the hope that this will catch users that do not set the input and rely on its default, which has now changed and would result in successful workflows that would however not upload anything to PyPI as expected. Remove the requirement of publish_on_pypi in the next next version. Update the documentation, adding warnings about the default value change to both the top of the specific workflow page, but also to the landing page. Add an example on how to still use the reusable/callable workflow and also the new PyPI Trusted Publisher feature.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #267 +/- ##
=======================================
Coverage 84.61% 84.61%
=======================================
Files 12 12
Lines 936 936
=======================================
Hits 792 792
Misses 144 144 ☔ View full report in Codecov by Sentry. |
francescalb
reviewed
Jul 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #180
Trusted Publisher is a feature from PyPI that is currently not supported from reusable/callable workflows.
To workaround this fact, the CD - Release workflow has been modified in two ways:
publish_on_pypihas been changed tofalse.upload_distributionthat defaults totrue.To support the latter, a new
build_dirinput has been added, which specifies the build target folder for the distribution. It should match either the custom output folder expressed in thebuild_cmdinput or the default build directory for the chosen build library.In an attempt to combat users that rely on default values of
publish_on_pypi, the input has been made a required input.Hopefully, this has the effect that for workflows, where it has not been specified explicitly, any runs using the latest version will fail, prompting users to check the documentation, where an informational admonition has been placed front and center on the landing page, as well as at the top of the CD - Release-specific documentation page.
Note, the status of "required" for
publish_on_pypiwill only last for the next minor version release (expected to be v2.8).The CD - Release-specific documentation page has had a new section added to it, regarding how one can utilize the workflow as well as implement PyPI's Trusted Publisher feature.
Example of the warning on the landing page that will be introduced by this PR:
