Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit ad366de

Browse files
committed
2 parents afd9e38 + e828c51 commit ad366de

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

CONTRIBUTING.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Checks
5656

5757
In both cases tox -p runs in parallel the following checks.
5858

59-
- Build Spinx Documentation
59+
- Build Sphinx Documentation
6060
- run pytest on all tests in ./tests
6161
- run mypy linting on all files in ./src ./tests
6262
- run pre-commit checks:
@@ -141,10 +141,15 @@ Releases are only made when the commandline tool needs to be released.
141141
When this happens:
142142

143143
- Choose a new PEP440 compliant release number
144-
- Git tag the version
145-
- Push to github and the actions will make a release on pypi
146-
- Push to internal gitlab and do a dls-release.py of the tag
147-
- Check and edit for clarity the autogenerated GitHub release_
144+
145+
- Go to the GitHub release_ page
146+
- Choose ``Draft New Release``
147+
- Click ``Choose Tag`` and supply the new tag you chose (click create new tag)
148+
- Click ``Generate release notes``, review and edit these notes
149+
- Choose a title and click ``Publish Release``
150+
151+
Note that tagging and pushing to the main branch has the same effect except that
152+
you will not get the option to edit the release notes.
148153

149154
.. _release: https://github.com/epics-containers/python3-pip-skeleton/releases
150155

@@ -155,6 +160,3 @@ Checking Dependencies
155160
To see a graph of the python package dependency tree type::
156161

157162
pipdeptree
158-
159-
160-

docs/tutorials/installation.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
Installation
22
============
33

4-
.. note::
5-
6-
If you want to contribute to the library itself, please follow
7-
the `../how-to/contributing` instructions.
8-
9-
104
Check your version of python
115
----------------------------
126

0 commit comments

Comments
 (0)