This is an automated email from the ASF dual-hosted git repository.
sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-trusted-releases.git
The following commit(s) were added to refs/heads/main by this push:
new 6265b87 Document the version identification system
6265b87 is described below
commit 6265b870c9563557081a7982905456973bbcb62f
Author: Sean B. Palmer <[email protected]>
AuthorDate: Wed Dec 3 15:42:18 2025 +0000
Document the version identification system
---
atr/get/start.py | 21 ++++++++++++++++++++-
atr/shared/start.py | 5 ++++-
2 files changed, 24 insertions(+), 2 deletions(-)
diff --git a/atr/get/start.py b/atr/get/start.py
index 8238eb6..96cada9 100644
--- a/atr/get/start.py
+++ b/atr/get/start.py
@@ -16,6 +16,7 @@
# under the License.
import asfquart.base as base
+import htpy
import atr.blueprints.get as get
import atr.db as db
@@ -71,7 +72,25 @@ async def _render_page(project: sql.Project, releases:
list[sql.Release]) -> htm
with row.block(htm.div, classes=".col-12") as col:
with col.block(htm.ul, classes=".list-unstyled.row.g-3") as ul:
_existing_releases(ul, releases)
-
+ page.h2(".mt-5")["Version numbers, revision serial numbers, and tags"]
+ page.p[
+ "Your version number should look like ",
+ htpy.code["1.2"],
+ " or ",
+ htpy.code["1.2.3"],
+ """ etc. and should not include a release candidate, alpha, beta, or
+ milestone portion. Whenever you modify your release files before
+ starting a vote, ATR creates a new revision serial number like """,
+ htpy.code["00002"],
+ """ which you can then refer to in the vote announcement email. You
+ can also tag revisions, and either the revision serial number or the
+ tag can be used in the vote announcement email. The tag can e.g. be
+ set to """,
+ htpy.code["M1"],
+ " or ",
+ htpy.code["rc1"],
+ ".",
+ ]
return page.collect()
diff --git a/atr/shared/start.py b/atr/shared/start.py
index 061a0d6..4a8d003 100644
--- a/atr/shared/start.py
+++ b/atr/shared/start.py
@@ -24,7 +24,10 @@ import atr.util as util
class StartReleaseForm(form.Form):
version_name: str = form.label(
"Version",
- "Enter the version string for this new release. Examples: 1.2.3 or
2.5-M1",
+ "Enter the version string for this new release."
+ " This cannot be changed later, and must be the version of the
finished release."
+ " ATR generates a unique revision serial number for each voting round,"
+ " and you can also set your own tag before a vote starts.",
)
@pydantic.field_validator("version_name", mode="after")
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
