Skip to content

Commit

Permalink
doc/RELEASE: do not pin dependencies on release
Browse files Browse the repository at this point in the history
Signed-off-by: Bastian Krause <[email protected]>
  • Loading branch information
Bastian-Krause committed Apr 26, 2023
1 parent 1e49a10 commit 095a8c8
Showing 1 changed file with 9 additions and 24 deletions.
33 changes: 9 additions & 24 deletions doc/RELEASE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,35 +15,20 @@ Check your commit mail and name:
git config --get user.name
git config --get user.email
1. Freeze Dependencies
======================

Freeze the dependencies into the `pyproject.toml` file and update the separate
feature requirements files.
This ensures that known good dependencies are available for every release.

2. Update setup.py Dependencies
===============================

Update the minimum required dependencies in the `setup.py` file.
These are intentionally non restrictive, see `PYPA Discussion
<https://packaging.python.org/discussions/install-requires-vs-requirements/>`_.
A frozen environment is already created in the previous step.

3. Update CHANGES.rst
1. Update CHANGES.rst
=====================

Update the `CHANGES.rst` file.
Ensure that no incompatiblities are unlisted and that all major features are
described in a separate section.
It's best to compare against the git log.

4. Bump Version Number
2. Bump Version Number
======================

Bump the version number in `CHANGES.rst`.

5. Create a signed Tag
3. Create a signed Tag
======================

Create a signed tag of the new release.
Expand All @@ -53,7 +38,7 @@ Your PGP-key has to be available on the computer.
git tag -s <your-version-number>
6. Create sdist
4. Create sdist
===============

Run the following command:
Expand All @@ -65,7 +50,7 @@ Run the following command:

The sdist file will be available in the `dist/` directory.

7. Test upload to pypi dev
5. Test upload to pypi dev
==========================

Test the upload by using twine to upload to pypi test service
Expand All @@ -74,7 +59,7 @@ Test the upload by using twine to upload to pypi test service

twine upload --repository-url https://test.pypi.org/legacy/ dist/*

8. Test download from pypi dev
6. Test download from pypi dev
==============================

Test the upload by using pypi dev as a download source
Expand All @@ -97,7 +82,7 @@ And optionally run the tests:
pip install ".[dev]"
pytest tests --crossbar-venv labgrid-crossbar-release-<your-version-number>

9. Upload to pypi
7. Upload to pypi
=================

Upload the tested dist file to pypi.
Expand All @@ -106,8 +91,8 @@ Upload the tested dist file to pypi.

twine upload dist/*

10. Upload the signed tag
==========================
8. Upload the signed tag
========================

Upload the signed tag to the upstream repository

Expand Down

0 comments on commit 095a8c8

Please sign in to comment.