← 返回首页
Add a guide about publishing dists via GH Actions by webknjaz · Pull Request #647 · pypa/packaging.python.org · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Add a guide about publishing dists via GH Actions#647

Merged
ncoghlan merged 17 commits into
pypa:masterfrom
webknjaz:features/publishing-dists-via-gh-actions-guide
Sep 27, 2019
Merged

Add a guide about publishing dists via GH Actions#647
ncoghlan merged 17 commits into
pypa:masterfrom
webknjaz:features/publishing-dists-via-gh-actions-guide

Conversation

Copy link
Copy Markdown
Member

webknjaz commented Sep 15, 2019

Copy link
Copy Markdown
Member Author

webknjaz commented Sep 15, 2019

@pradyunsg @cjerdonek ^

hugovk reviewed Sep 16, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

hugovk left a comment

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Looks good, some minor suggestions.

Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
12 hidden conversations Load more…
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Copy link
Copy Markdown
Member Author

webknjaz commented Sep 16, 2019

Folks, this is ready for a new round of reviews. I've factored out the workflow sample into a separate file and addressed all the major concerns.

hugovk reviewed Sep 18, 2019
View reviewed changes
Copy link
Copy Markdown
Contributor

hugovk left a comment

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Looks good, just a few more minor bits!

Comment thread source/guides/github-actions-ci-cd-sample/publish-to-test-pypi.yml
.
# Actualy publish to PyPIs
- name: Publish 📦 to Test PyPI
uses: pypa/gh-action-pypi-publish@master
Copy link
Copy Markdown
Contributor

hugovk Sep 18, 2019

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Once there's a release, include the version number here.

We strongly recommend that you include the version of the action you are using by specifying a Git ref, SHA, or Docker tag number. If you don't specify a version, it could break your workflows or cause unexpected behavior when the action owner publishes an update.

  • Using the commit SHA of a released action version is the safest for stability and security.
  • Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.
  • Using the master branch of an action may be convenient, but if someone releases a new major version with a breaking change, your workflow could break.

https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepsuses

Copy link
Copy Markdown
Member Author

webknjaz Sep 18, 2019

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Sure, I'd also mention it somewhere in the README of the action itself.

Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Copy link
Copy Markdown
Member Author

webknjaz commented Sep 18, 2019

@di @ncoghlan I think this is waiting for merge now. Mind taking a look? TIA.

Apply style and grammar corrections …
5fa47af
Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com>
di reviewed Sep 19, 2019
View reviewed changes
Copy link
Copy Markdown
Member

di left a comment

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

This looks pretty good.

I'm not 100% sure that we should advise users to publish to TestPyPI on every push, but I think it's probably OK.

Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/github-actions-ci-cd-sample/publish-to-test-pypi.yml Outdated Show resolved Hide resolved
Comment thread source/guides/github-actions-ci-cd-sample/publish-to-test-pypi.yml Outdated Show resolved Hide resolved
22 hidden conversations Load more…
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
Comment thread source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved
webknjaz mentioned this pull request Sep 19, 2019
Merged
webknjaz added a commit to pypa/gh-action-pypi-publish that referenced this pull request Sep 19, 2019
Test PyPI -> TestPyPI in README …
9cebe9a
PR #13 by @hugovk Ref: pypa/packaging.python.org#647 (comment)
webknjaz and others added 3 commits September 19, 2019 12:38
Fix TestPyPI spelling …
9a15647
Co-Authored-By: Dustin Ingram <di@users.noreply.github.com>
Use long versions of words in the guide …
bdcc968
Co-Authored-By: Dustin Ingram <di@users.noreply.github.com>
Apply style fixes from code review …
4b1e6d2
Co-Authored-By: Dustin Ingram <di@users.noreply.github.com>
webknjaz requested a review from di September 19, 2019 13:50
webknjaz mentioned this pull request Sep 19, 2019
Closed
10 tasks
Copy link
Copy Markdown
Member Author

webknjaz commented Sep 22, 2019

@di would you please take a look?

39 hidden items Load more…
pradyunsg approved these changes Sep 26, 2019
View reviewed changes
Copy link
Copy Markdown
Member

pradyunsg left a comment

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

I think this is good-enough to publish now; we can always iterate and improve this as we go.

webknjaz mentioned this pull request Sep 26, 2019
Closed
breznak mentioned this pull request Sep 26, 2019
Closed
4 tasks
ncoghlan approved these changes Sep 27, 2019
View reviewed changes
Copy link
Copy Markdown
Member

ncoghlan left a comment

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Concur with @pradyunsg here - I think there are some interesting questions on specifics in the remaining comments, but I also think they can be tackled via a follow-up PR.

ncoghlan merged commit b852020 into pypa:master Sep 27, 2019
Copy link
Copy Markdown
Member Author

webknjaz commented Sep 27, 2019

Thanks, Nick! I'm also aware of other problems that need to be addressed and I'm going to solve those too, in the follow-up PRs.

pfmoore mentioned this pull request Sep 9, 2020
Closed

This comment was marked as outdated.

Sign in to view
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ncoghlan ncoghlan approved these changes

pradyunsg pradyunsg approved these changes

pfmoore Awaiting requested review from pfmoore

di Awaiting requested review from di

+2 more reviewers

hugovk hugovk approved these changes

yfc938183-boop yfc938183-boop left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add a usage guide to packaging.python.org

7 participants

Footer

© 2026 GitHub, Inc.