From 6e5583eeeef481cb2061207bad2c7f61d5a3a757 Mon Sep 17 00:00:00 2001 From: Shatakshi Mishra Date: Fri, 9 Feb 2024 14:46:17 +0530 Subject: [PATCH] Update readme to include calver release information (#270) --- .config/dictionary.txt | 1 + README.md | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/.config/dictionary.txt b/.config/dictionary.txt index a3ffa7a..d8d3e17 100644 --- a/.config/dictionary.txt +++ b/.config/dictionary.txt @@ -1,5 +1,6 @@ autouse basepython +calver cidrblock delenv devel diff --git a/README.md b/README.md index 86fa213..31e6921 100644 --- a/README.md +++ b/README.md @@ -139,6 +139,13 @@ This will skip tests in any environment that uses Ansible 2.9 or the devel branc [guide]: https://ansible.readthedocs.io/projects/tox-ansible/configuration/#overriding-the-configuration +## Release process + +`tox-ansible` is released with [CalVer] scheme version numbers. The particular scheme we are using is `YY.MM.MICRO`, meaning that a release in March 2025 will be named `25.3.0`, and if a patch (ie, non-feature) release is required for that release, it will be named 25.3.1, even if it is released in April. The month will not increment until a new version with features or other significant changes is released. More details about calver release process can be seen [here]. + +[here]: https://ansible.readthedocs.io/projects/team-devtools/guides/calver/ +[CalVer]: https://calver.org/ + ## Note to version 1.x users Users of tox-ansible v1 should use the stable/1.x branch because the default branch is a rewrite of the plugin for tox 4.0+ which is not backward compatible with the old plugin.