Skip to content

Commit 77e66a5

Browse files
committed
add package release workflow instructions
1 parent ee80eab commit 77e66a5

2 files changed

Lines changed: 28 additions & 2 deletions

File tree

docs/source/contributing/development.rst

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Pull Request Review Workflow
174174

175175
If the feature branch included new functionality, the following
176176
should have also been updated:
177-
177+
178178
* the "Code Organization" section of the :code:`README.md`
179179
* the "Code Organization" section of
180180
:code:`docs/source/index.rst` to match the :code:`README.md`
@@ -204,3 +204,29 @@ Pull Request Review Workflow
204204
See the :ref:`Coverage Report<coverage>` section for more details.
205205

206206
7. Submit your approval or any comments on GitHub.
207+
208+
New Package Release Workflow
209+
--------------------
210+
211+
1. Create new branch for the release:
212+
213+
.. code-block:: bash
214+
215+
git checkout -b your-name/release-X.Y.Z
216+
217+
2. Open the ``pyproject.toml`` file and under the ``[tool.poetry]``
218+
group change the ``version = X.Y.Z`` variable to match the new
219+
package version number.
220+
221+
3. Create a new pull request and merge to the ``main`` branch using the
222+
development process above.
223+
224+
4. Go to the `releases page <https://github.com/Stanford-NavLab/gnss_lib_py/releases>`__
225+
on GitHub and click the ``Draft a new release`` button on the top.
226+
Click ``Choose a tag`` and add a new tag named ``X.Y.Z`` matching the
227+
new package version number. Target the ``main`` branch. Finally,
228+
click the ``Publish release`` button.
229+
230+
5. Allow time for the release to build and then check
231+
`pypi <https://pypi.org/project/gnss-lib-py/>`__
232+
to ensure that the release was built successfully.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "gnss-lib-py"
3-
version = "0.1.7"
3+
version = "0.1.8"
44
description = "Modular Python tool for parsing, analyzing, and visualizing Global Navigation Satellite Systems (GNSS) data and state estimates"
55
authors = ["Derek Knowles <dcknowles@stanford.edu>",
66
"Ashwin Kanhere <akanhere@stanford.edu>",

0 commit comments

Comments
 (0)