Skip to content

Commit a4f8a0e

Browse files
henryiiiwebknjaz
authored andcommitted
fix: partial review update
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
1 parent 88ce3aa commit a4f8a0e

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ It will use the `pypa/gh-action-pypi-publish GitHub Action`_.
1212

1313
.. attention::
1414

15-
This guide *assumes* that you already have a project that
16-
you know how to build distributions for and *it lives on GitHub*.
17-
This guide also assumes you have a pure Python project. If you
18-
have binary compoents, check out :ref:`cibuildwheel`.
15+
This guide *assumes* that you already have a project that you know how to
16+
build distributions for and *it lives on GitHub*. This guide also avoids
17+
details of building platform specific projects. If you have binary
18+
components, check out :ref:`cibuildwheel`'s GitHub Action examples.
1919

2020
Saving credentials on GitHub
2121
============================
@@ -102,13 +102,15 @@ use ``build`` package.
102102

103103
You can use any other method for building distributions as long as
104104
it produces ready-to-upload artifacts saved into the
105-
``dist/`` folder.
105+
``dist/`` folder. You can even use ``actions/upload-artifact`` and
106+
``actions/download-artifact`` to tranfer files between jobs or make them
107+
accessable for download from the web CI interface.
106108

107109
So add this to the steps list:
108110

109111
.. literalinclude:: github-actions-ci-cd-sample/publish-to-test-pypi.yml
110112
:language: yaml
111-
:start-after: version: "3.10"
113+
:start-after: version: "3.x"
112114
:end-before: Actually publish to PyPI/TestPyPI
113115

114116

@@ -124,7 +126,9 @@ Finally, add the following steps at the end:
124126
These two steps use the `pypa/gh-action-pypi-publish`_ GitHub
125127
Action: the first one uploads contents of the ``dist/`` folder
126128
into TestPyPI unconditionally and the second does that to
127-
PyPI, but only if the current commit is tagged.
129+
PyPI, but only if the current commit is tagged. It is recommended
130+
you use the latest release tag; a tool like GitHub's dependabot can keep
131+
these updated regularly.
128132

129133

130134
That's all, folks!

0 commit comments

Comments
 (0)