Skip to content

Commit

Permalink
Update release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hardbyte committed Jun 6, 2024
1 parent d9b9a19 commit 3c3b616
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 5 deletions.
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ jobs:
runs-on: ubuntu-latest
permissions:
id-token: write
attestations: write

# upload to PyPI only on release
if: github.event.release && github.event.action == 'published'
Expand Down
2 changes: 1 addition & 1 deletion can/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import logging
from typing import Any, Dict

__version__ = "4.4.0-rc.1"
__version__ = "4.4.0-rc.2"
__all__ = [
"ASCReader",
"ASCWriter",
Expand Down
14 changes: 10 additions & 4 deletions doc/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,19 @@ Creating a new Release
- Update ``CONTRIBUTORS.txt`` with any new contributors.
- For larger changes update ``doc/history.rst``.
- Sanity check that documentation has stayed inline with code.
- Create a temporary virtual environment. Run ``python setup.py install`` and ``tox``.
- Create and upload the distribution: ``python setup.py sdist bdist_wheel``.
- Sign the packages with gpg ``gpg --detach-sign -a dist/python_can-X.Y.Z-py3-none-any.whl``.
- Upload with twine ``twine upload dist/python-can-X.Y.Z*``.
- In a new virtual env check that the package can be installed with pip: ``pip install python-can==X.Y.Z``.
- Create a new tag in the repository.
- Check the release on
`PyPi <https://pypi.org/project/python-can/#history>`__,
`Read the Docs <https://readthedocs.org/projects/python-can/versions/>`__ and
`GitHub <https://github.com/hardbyte/python-can/releases>`__.


Manual release steps (deprecated)
---------------------------------

- Create a temporary virtual environment.
- Build with ``pipx run build``
- Create and upload the distribution: ``python setup.py sdist bdist_wheel``.
- Sign the packages with gpg ``gpg --detach-sign -a dist/python_can-X.Y.Z-py3-none-any.whl``.
- Upload with twine ``twine upload dist/python-can-X.Y.Z*``.

0 comments on commit 3c3b616

Please sign in to comment.