Skip to content

Commit f2cd457

Browse files
update version management instructions in CONTRIBUTING.rst
1 parent 6360dbd commit f2cd457

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,13 +278,20 @@ Then push both commits and tags to your fork:
278278
Writing objects: 100% (1/1), 205 bytes | 205.00 KiB/s, done.
279279
Total 1 (delta 0), reused 0 (delta 0), pack-reused 0
280280
To github.com:softwareengineerprogrammer/python-geophires-x-nrel.git
281-
* [new tag] v3.2.3 -> v3.2.3
281+
* [new tag] v3.2.3-alpha.0 -> v3.2.3-alpha.0
282+
283+
Once the alpha version builds successfully in GitHubActions and you're ready to release it as v3.2.3:
284+
285+
.. code-block::
286+
287+
(venv) ➜ python-geophires-x git:(main) bumpversion release
288+
(venv) ➜ python-geophires-x git:(main) git push && git push fork --tags
282289
283290
Once a version bump is merged into the main repository with a Pull Request, tags must be manually pushed (GitHub `doesn't include tags in PRs <https://stackoverflow.com/questions/12278660/adding-tags-to-a-pull-request>`__):
284291

285292
.. code-block::
286293
287-
(venv) ➜ python-geophires-x git:(main) git push origin --tags
294+
(venv) ➜ python-geophires-x git:(main) git push origin tag v3.2.3
288295
289296
290297
Documentation Updates

0 commit comments

Comments
 (0)