Skip to content

Commit 83c5934

Browse files
authored
add Build wheel and source tarball in publish.yml (#199)
* add Build wheel and source tarball in publish.yml * Update CONTRIBUTING.rst
1 parent 8d57c82 commit 83c5934

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

.github/workflows/publish.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ jobs:
1515
- name: Install "build"
1616
run: |
1717
python -m pip install build
18+
- name: Build wheel and source tarball
19+
run: |
20+
python -m build
1821
- name: Store the distribution packages
1922
uses: actions/upload-artifact@v4
2023
with:

CONTRIBUTING.rst

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,22 +62,20 @@ whatever you need with ``uv run``.
6262
Creating a New Release
6363
^^^^^^^^^^^^^^^^^^^^^^
6464

65-
New releases are made using the following steps:
65+
These steps for creating a new release are proposed to be taken only after
66+
ensuring that CI (unit tests, sphinx for RTD_, build of wheel and source distribution)
67+
raised no errors.
6668

6769
#. Bump version number in ``sfs/__init__.py``
6870
#. Update ``NEWS.rst``
6971
#. Commit those changes as "Release x.y.z"
7072
#. Create an (annotated) tag with ``git tag -a x.y.z``
71-
#. Clear the ``dist/`` directory
72-
#. Create a source distribution with ``python3 setup.py sdist``
73-
#. Create a wheel distribution with ``python3 setup.py bdist_wheel``
74-
#. Check that both files have the correct content
75-
#. Upload them to PyPI_ with twine_: ``python3 -m twine upload dist/*``
76-
#. Push the commit and the tag to Github and `add release notes`_ containing a
77-
link to PyPI and the bullet points from ``NEWS.rst``
78-
#. Check that the new release was built correctly on RTD_
79-
and select the new release as default version
80-
81-
.. _twine: https://twine.readthedocs.io/
73+
#. Push the commit and the tag to Github
74+
#. The workflow ``.github/workflows/publish.yml`` will handle the build and the
75+
upload to PyPI
76+
#. `Add release notes`_ containing a link to PyPI and the bullet points
77+
from the updated ``NEWS.rst``
78+
#. Select the new release as the default on RTD_
79+
8280
.. _add release notes: https://github.com/sfstoolbox/sfs-python/tags
8381
.. _RTD: https://readthedocs.org/projects/sfs-python/builds/

0 commit comments

Comments
 (0)