Add a guide about publishing dists via GH Actions by webknjaz · Pull Request #647 · pypa/packaging.python.org

webknjaz · 2019-09-15T21:01:07Z

Resolves pypa/gh-action-pypi-publish#2

webknjaz · 2019-09-15T21:03:46Z

@pradyunsg @cjerdonek ^

hugovk

Looks good, some minor suggestions.

source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst

Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com>

webknjaz · 2019-09-16T21:43:14Z

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

Looks good, just a few more minor bits!

hugovk · 2019-09-18T08:49:42Z

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


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

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

source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst

webknjaz · 2019-09-18T09:20:59Z

@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>

di

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.

source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst

source/guides/github-actions-ci-cd-sample/publish-to-test-pypi.yml

source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst

@hugovk

PR #13 by @hugovk Ref: pypa/packaging.python.org#647 (comment)

Co-Authored-By: Dustin Ingram <di@users.noreply.github.com>

webknjaz · 2019-09-22T20:27:03Z

@di would you please take a look?

pradyunsg

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

ncoghlan

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.

webknjaz · 2019-09-27T11:20:36Z

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.

Add a guide about publishing dists via GH Actions

e880724

Resolves pypa/gh-action-pypi-publish#2

hugovk reviewed Sep 16, 2019

View reviewed changes

pfmoore reviewed Sep 16, 2019

View reviewed changes

source/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows.rst Outdated Show resolved Hide resolved

webknjaz and others added 8 commits September 16, 2019 23:47

Apply style corrections

3fc3244

Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com>

Drop emojis from the guide title

0b3ff39

Align guide titles' styles

a625acf

Store GitHub Actions CI/CD workflow def separately

7a9912f

Un-highlight the assumption

d3a7e8d

Wrap lines better in RST

819c527

Add a waitlist link

1e8ba48

Fix a bug/snake emoji in the GH workflow sample

b746ce2

webknjaz requested review from pfmoore and pradyunsg September 16, 2019 21:43

hugovk reviewed Sep 18, 2019

View reviewed changes

Apply style and grammar corrections

5fa47af

Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com>

hugovk approved these changes Sep 18, 2019

View reviewed changes

di reviewed Sep 19, 2019

View reviewed changes

webknjaz mentioned this pull request Sep 19, 2019

Test PyPI -> TestPyPI pypa/gh-action-pypi-publish#13

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 added 2 commits September 19, 2019 15:57

Add a note that PyPI acc != TestPyPI acc

db67d03

Drop a note about GH Actions GA on Nov 13th

37948f8

webknjaz mentioned this pull request Sep 19, 2019

[metaissue] Action items for going live pypa/gh-action-pypi-publish#1

Closed

10 tasks

webknjaz added 2 commits September 26, 2019 01:33

Mention GitHub Action Marketplace page

a807576

Add a missing Action repo link

0cad254

pradyunsg approved these changes Sep 26, 2019

View reviewed changes

webknjaz mentioned this pull request Sep 26, 2019

Automate deployment to PyPI scikit-hep/pyhf#508

Closed

breznak mentioned this pull request Sep 26, 2019

Publish bindings on pypi htm-community/htm.core#19

Closed

4 tasks

ncoghlan approved these changes Sep 27, 2019

View reviewed changes

ncoghlan merged commit b852020 into pypa:master Sep 27, 2019

pfmoore mentioned this pull request Sep 9, 2020

Redirect any pep517 package porcelain commands references to python-build #770

Closed

This comment was marked as outdated.

Sign in to view

Conversation

webknjaz commented Sep 15, 2019

Uh oh!

webknjaz commented Sep 15, 2019

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

webknjaz commented Sep 16, 2019

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

hugovk Sep 18, 2019

Choose a reason for hiding this comment

Uh oh!

webknjaz Sep 18, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

webknjaz commented Sep 18, 2019

Uh oh!

di left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

webknjaz commented Sep 22, 2019

Uh oh!

pradyunsg left a comment

Choose a reason for hiding this comment

Uh oh!

ncoghlan left a comment

Choose a reason for hiding this comment

Uh oh!

webknjaz commented Sep 27, 2019

Uh oh!

This comment was marked as outdated.

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants