Skip to content

Commit 2b69cdd

Browse files
committed
Move release procedure from wiki.
1 parent 9fc8efb commit 2b69cdd

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,44 @@ Installation
3838
For the full build instructions, see the `documentation
3939
<http://vi-firmware.openxcplatform.com/en/latest/installation/installation.html>`_.
4040

41+
42+
Releasing
43+
=========
44+
45+
- Make sure you release the Python library first if there are any updates
46+
47+
- Update ``script/bootstrap/ci-requirements.txt`` to use released version at PyPI
48+
(i.e. the requirement should be ``openxc==<latestversion>``)
49+
50+
- Bump the version using `semantic versioning`_ in
51+
- ``CHANGELOG.mkd``
52+
- ``README.mkd``
53+
- ``src/config.cpp``
54+
- ``docs/index.rst``
55+
- ``docs/conf.py``
56+
57+
- Checkout master, merge in next
58+
59+
- Run 'fab release', say yes to the tag and use the format ``v0.9.1``
60+
61+
- This will run the test suite, tag, and push to GitHub
62+
63+
- Checkout the next branch, and edit the same files to change the version to the
64+
next development release (one patch release up with the ``-dev`` suffix, e.g.
65+
``v0.9.2-dev``
66+
67+
- Also change ``script/pip-requirements.txt`` back to using the development
68+
version from Git: ``-e git+https://github.com/openxc/openxc-python.git@next#egg=openxc``
69+
70+
- Go to https://github.com/openxc/vi-firmware/releases and promote the tag you
71+
just created to a new release - copy and paste the changelog into the
72+
description.
73+
74+
- Attach the ``openxc-vi-firmware-*.zip`` from the ``releases`` directory to
75+
the release on GitHub
76+
77+
.. _`semantic versioning`: http://semver.org
78+
4179
License
4280
=======
4381

0 commit comments

Comments
 (0)