Skip to content
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.

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

Add a guide about publishing dists via GH Actions #647

Merged

Conversation

@webknjaz
Copy link
Member

webknjaz commented Sep 15, 2019

@webknjaz

This comment has been minimized.

Copy link
Member Author

webknjaz commented Sep 15, 2019

webknjaz and others added 8 commits Sep 16, 2019
Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com>
@webknjaz

This comment has been minimized.

Copy link
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.

@webknjaz webknjaz requested review from pradyunsg and pfmoore Sep 16, 2019
Copy link
Contributor

hugovk left a comment

Looks good, just a few more minor bits!

.
# Actualy publish to PyPIs
- name: Publish 📦 to Test PyPI
uses: pypa/gh-action-pypi-publish@master

This comment has been minimized.

Copy link
@hugovk

hugovk Sep 18, 2019

Contributor

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

This comment has been minimized.

Copy link
@webknjaz

webknjaz Sep 18, 2019

Author Member

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

@webknjaz

This comment has been minimized.

Copy link
Member Author

webknjaz commented Sep 18, 2019

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

Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com>
@hugovk
hugovk approved these changes Sep 18, 2019
Copy link
Member

di left a 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.

@webknjaz webknjaz referenced this pull request Sep 19, 2019
webknjaz added a commit to pypa/gh-action-pypi-publish that referenced this pull request Sep 19, 2019
webknjaz and others added 3 commits Sep 19, 2019
Co-Authored-By: Dustin Ingram <di@users.noreply.github.com>
Co-Authored-By: Dustin Ingram <di@users.noreply.github.com>
Co-Authored-By: Dustin Ingram <di@users.noreply.github.com>
@webknjaz webknjaz requested a review from di Sep 19, 2019
webknjaz added 2 commits Sep 19, 2019
@webknjaz webknjaz referenced this pull request Sep 19, 2019
6 of 10 tasks complete
@webknjaz

This comment has been minimized.

Copy link
Member Author

webknjaz commented Sep 22, 2019

@di would you please take a look?

webknjaz added 2 commits Sep 25, 2019
Copy link
Member

pradyunsg left a comment

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

Copy link
Member

ncoghlan left a 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 ncoghlan merged commit b852020 into pypa:master Sep 27, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@webknjaz

This comment has been minimized.

Copy link
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.