From 8f4779a4d5fc640403fb639addafd31dadc6bcbb Mon Sep 17 00:00:00 2001 From: Kate Case Date: Tue, 23 Jan 2024 08:10:06 -0500 Subject: [PATCH 1/3] Add calver transition document --- docs/guides/calver-transition.md | 67 ++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 docs/guides/calver-transition.md diff --git a/docs/guides/calver-transition.md b/docs/guides/calver-transition.md new file mode 100644 index 0000000..6e9ae18 --- /dev/null +++ b/docs/guides/calver-transition.md @@ -0,0 +1,67 @@ +# Devtools Projects Transitioning to CalVer Releases + +Projects in the devtools space will be switching to [CalVer](https://calver.org/) +releases over the next few weeks. This is a surprising change, so let's get into +what that means. + +## What + +These are the projects that will be transitioning to CalVer: + +* ansible-compat +* ansible-creator +* ansible-dev-environment +* ansible-lint +* ansible-navigator +* creator-ee +* molecule +* pytest-ansible +* tox-ansible +* vscode-ansible + +We will use a `YY.MM.MICRO` version format. Thus, a release for 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, and the month will not +increment until a new version with features or other significant changes is released. + +## Why + +This is a bit of a change so let's go over what we hope to accomplish with it. + +* Predictable, transparent release cadence + + With this, we are committing to time-based releases for all projects. + While the exact frequency will vary between projects, each will have a release + between one and three months after the last feature release. + +* Version number indicates the age of a release + + When looking at a version number, there's no good way of telling how old it is + without looking up the release notes. + +* Easier to translate versions between tools + + Many of our tools are interrelated. A consistent version scheme allows one to + have a good idea of how related but independent tools are expected to work together. + +## How + +Following this announcement, the next feature release in each project will +be a CalVer release. + +Feature releases will not happen more often than once a month, though +patch releases may happen more often as needed. We will also make +releases at least once every three months for each project. + +Releases will still split out features and removals by category, including +minor and major features, announced deprecations, and removed features. + +One of the things we are bringing with this change is an emphasis on fewer +breaking changes / more emphasis on deprecation cycles and overlapping features. +When something is deprecated, it will be called out in the release notes, along +with replacement and how long the feature will remain in place. + +## What's Next + +As mentioned, this change will begin rolling out over the next few weeks. However, +if you have any comments or concerns, please let us know. From c6db1b8a75dc94b89cd6fcae09c63293b7f0d65c Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 23 Jan 2024 13:15:23 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/guides/calver-transition.md | 40 ++++++++++++++++---------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/guides/calver-transition.md b/docs/guides/calver-transition.md index 6e9ae18..efc4c4f 100644 --- a/docs/guides/calver-transition.md +++ b/docs/guides/calver-transition.md @@ -8,16 +8,16 @@ what that means. These are the projects that will be transitioning to CalVer: -* ansible-compat -* ansible-creator -* ansible-dev-environment -* ansible-lint -* ansible-navigator -* creator-ee -* molecule -* pytest-ansible -* tox-ansible -* vscode-ansible +- ansible-compat +- ansible-creator +- ansible-dev-environment +- ansible-lint +- ansible-navigator +- creator-ee +- molecule +- pytest-ansible +- tox-ansible +- vscode-ansible We will use a `YY.MM.MICRO` version format. Thus, a release for March 2025 will be named `25.3.0`, and if a patch (ie, non-feature) release is required for that release, @@ -28,21 +28,21 @@ increment until a new version with features or other significant changes is rele This is a bit of a change so let's go over what we hope to accomplish with it. -* Predictable, transparent release cadence +- Predictable, transparent release cadence - With this, we are committing to time-based releases for all projects. - While the exact frequency will vary between projects, each will have a release - between one and three months after the last feature release. + With this, we are committing to time-based releases for all projects. + While the exact frequency will vary between projects, each will have a release + between one and three months after the last feature release. -* Version number indicates the age of a release +- Version number indicates the age of a release - When looking at a version number, there's no good way of telling how old it is - without looking up the release notes. + When looking at a version number, there's no good way of telling how old it is + without looking up the release notes. -* Easier to translate versions between tools +- Easier to translate versions between tools - Many of our tools are interrelated. A consistent version scheme allows one to - have a good idea of how related but independent tools are expected to work together. + Many of our tools are interrelated. A consistent version scheme allows one to + have a good idea of how related but independent tools are expected to work together. ## How From 600ba328970f876f803068aefd887599bd036ffc Mon Sep 17 00:00:00 2001 From: Kate Case Date: Tue, 23 Jan 2024 11:19:02 -0500 Subject: [PATCH 3/3] Clarify wording of release age and release notes categories --- docs/guides/calver-transition.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/guides/calver-transition.md b/docs/guides/calver-transition.md index efc4c4f..950774b 100644 --- a/docs/guides/calver-transition.md +++ b/docs/guides/calver-transition.md @@ -36,8 +36,8 @@ This is a bit of a change so let's go over what we hope to accomplish with it. - Version number indicates the age of a release - When looking at a version number, there's no good way of telling how old it is - without looking up the release notes. + With CalVer, the age of a release can be trivially determined from the version + number, instead of having to look up the release notes as at present. - Easier to translate versions between tools @@ -53,8 +53,8 @@ Feature releases will not happen more often than once a month, though patch releases may happen more often as needed. We will also make releases at least once every three months for each project. -Releases will still split out features and removals by category, including -minor and major features, announced deprecations, and removed features. +Releases will still split out changes by category, including new features, +bugfixes, documentation updates, announced deprecations, and removed features. One of the things we are bringing with this change is an emphasis on fewer breaking changes / more emphasis on deprecation cycles and overlapping features.