Skip to content

Fix a few issues in maintaing doc #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
StanFromIreland wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −5
Open

Fix a few issues in maintaing doc #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Apache Software License 2.0

Copyright (c) 2020, Paul Ganssle (Google)
Copyright (c) 2026, Stan Ulbrych

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
10 changes: 5 additions & 5 deletions docs/maintaining.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ repository root, and it is updated in two ways:

1. The "base version" (e.g. 2020.1) is set by ``tox -e update``.
2. The additional markers such as pre (release candidate), post and dev are
managed by ``tox -e bump_version``.
managed by ``tox -e bump``.

The version follows the scheme::

YYYY.minor[rcX][.postY][.devZ]

Bumping any component removes all values to its right as well, so for example,
if the base version were ``20201rc1.post2.dev0``::
if the base version were ``2020.1rc1.post2.dev0``::

$ tox -e bump -- --dev --dry-run
...
Expand All @@ -78,8 +78,8 @@ To remove all additional markers and get a simple "release" version, use
...
2020.1rc1.post2.dev0 → 2020.1

For more information on how to use ``bump_version``, run ``tox -e bump_version
-- -help``.
For more information on how to use ``bump_version``, run ``tox -e bump
-- --help``.

Making a release
----------------
Expand Down Expand Up @@ -112,4 +112,4 @@ is immutable and each release burns a version number.

.. Links
.. |tox| replace:: ``tox``
.. _tox: https://tox.readthedocs.io/en/latest/
.. _tox: https://tox.wiki/en/latest/
Loading