From f7f5100ece973a4b6732f8232c73fa03c6ba726b Mon Sep 17 00:00:00 2001 From: "Bradley A. Thornton" Date: Mon, 22 Jul 2024 07:14:45 -0700 Subject: [PATCH 1/4] Release notes --- .config/dictionary.txt | 4 +++ cspell.config.yaml | 24 +++++++++++++ docs/guides/releases.md | 77 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 105 insertions(+) create mode 100644 .config/dictionary.txt create mode 100644 cspell.config.yaml create mode 100644 docs/guides/releases.md diff --git a/.config/dictionary.txt b/.config/dictionary.txt new file mode 100644 index 0000000..14a90e1 --- /dev/null +++ b/.config/dictionary.txt @@ -0,0 +1,4 @@ +alisonlhart +cidrblock +compat +pytest \ No newline at end of file diff --git a/cspell.config.yaml b/cspell.config.yaml new file mode 100644 index 0000000..ab9045f --- /dev/null +++ b/cspell.config.yaml @@ -0,0 +1,24 @@ +dictionaryDefinitions: + - name: words + path: .config/dictionary.txt + addWords: true +dictionaries: + - bash + - networking-terms + - python + - words + - "!aws" + - "!backwards-compatibility" + - "!cryptocurrencies" + - "!cpp" +ignorePaths: + - .config/requirements* + - \.* + - cspell.config.yaml + - mkdocs.yml + - pyproject.toml + - tox.ini + +languageSettings: + - languageId: python + allowCompoundWords: false diff --git a/docs/guides/releases.md b/docs/guides/releases.md new file mode 100644 index 0000000..717a1e1 --- /dev/null +++ b/docs/guides/releases.md @@ -0,0 +1,77 @@ +# Releases + +## Overview + +The projects maintained by the Ansible dev tools team have a target release frequency of 1 month. Some project may have more than 1 release per month based on project velocity or frequency of bug fixes or feature additions. + +One person within the devtools team will act as "release manager" each month. This will ensure each project is reviewed to ensure a release for that month was made. If a particular project's CI tests are failing, the project maintainer will work with the release manager to clear the block. If a project already has a release within the current month a new release is not necessary unless there are merged PRs and release notes available for a new release. + +The following project should be release first, in no particular order: + +- [ansible-compat](https://github.com/ansible/ansible-compat/releases) + +The following projects should be release second, in no particular order: + +- [ansible-creator](https://github.com/ansible/ansible-creator/releases) +- [ansible-dev-environment](https://github.com/ansible/ansible-dev-environment/releases) +- [ansible-lint](https://github.com/ansible/ansible-lint/releases) +- [ansible-navigator](https://github.com/ansible/ansible-navigator/releases) +- [molecule](https://github.com/ansible/ansible-molecule/releases) +- [pytest-ansible](https://github.com/ansible/ansible-creator/releases) +- [tox-ansible](https://github.com/ansible/tox-ansible/releases) +- [VsCode extension](https://github.com/ansible/vscode-ansible/releases) + +Finally, after running dependabot so the release notes are updated with dependencies: + +- [ansible-dev-tools](https://github.com/ansible/ansible-dev-tools/releases) + +This will release both a python project and image. Both the resulting python package and image should be validated to ensure each reflects the latest releases. + +- [ansible-dev-tools on pypi](https://pypi.org/project/ansible-dev-tools/#history) +- [ansible-dev-tools image](https://github.com/ansible/ansible-dev-tools/pkgs/container/community-ansible-dev-tools) + + + +## Schedule + +Releases should be made on the first Wednesday of the month, but can be made the following Wednesday if necessary. This document should be updated with a pull request after the releases are complete. + +### 2024-11 + +Release manager: + +Completed date: + +Notes: + +### 2024-10 + +Release manager: + +Completed date: + +Notes: + +### 2024-09 + +Release manager: + +Completed date: + +Notes: + +### 2024-08 + +Release manager: + +Completed date: + +Notes: + +### 2024-08 + +Release manager: @alisonlhart + +Completed date: 2024-07-18 + +Notes: \ No newline at end of file From 905f1f3f8ab1c455ba30cf6cb5ba5d4dd615814a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 22 Jul 2024 14:15:52 +0000 Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- .config/dictionary.txt | 2 +- docs/guides/releases.md | 8 +++----- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.config/dictionary.txt b/.config/dictionary.txt index 14a90e1..b111629 100644 --- a/.config/dictionary.txt +++ b/.config/dictionary.txt @@ -1,4 +1,4 @@ alisonlhart cidrblock compat -pytest \ No newline at end of file +pytest diff --git a/docs/guides/releases.md b/docs/guides/releases.md index 717a1e1..c10a72d 100644 --- a/docs/guides/releases.md +++ b/docs/guides/releases.md @@ -2,9 +2,9 @@ ## Overview -The projects maintained by the Ansible dev tools team have a target release frequency of 1 month. Some project may have more than 1 release per month based on project velocity or frequency of bug fixes or feature additions. +The projects maintained by the Ansible dev tools team have a target release frequency of 1 month. Some project may have more than 1 release per month based on project velocity or frequency of bug fixes or feature additions. -One person within the devtools team will act as "release manager" each month. This will ensure each project is reviewed to ensure a release for that month was made. If a particular project's CI tests are failing, the project maintainer will work with the release manager to clear the block. If a project already has a release within the current month a new release is not necessary unless there are merged PRs and release notes available for a new release. +One person within the devtools team will act as "release manager" each month. This will ensure each project is reviewed to ensure a release for that month was made. If a particular project's CI tests are failing, the project maintainer will work with the release manager to clear the block. If a project already has a release within the current month a new release is not necessary unless there are merged PRs and release notes available for a new release. The following project should be release first, in no particular order: @@ -30,8 +30,6 @@ This will release both a python project and image. Both the resulting python pac - [ansible-dev-tools on pypi](https://pypi.org/project/ansible-dev-tools/#history) - [ansible-dev-tools image](https://github.com/ansible/ansible-dev-tools/pkgs/container/community-ansible-dev-tools) - - ## Schedule Releases should be made on the first Wednesday of the month, but can be made the following Wednesday if necessary. This document should be updated with a pull request after the releases are complete. @@ -74,4 +72,4 @@ Release manager: @alisonlhart Completed date: 2024-07-18 -Notes: \ No newline at end of file +Notes: From 2ff27ac4e061d4fb63f5b7d242b0d56e74973fac Mon Sep 17 00:00:00 2001 From: "Bradley A. Thornton" Date: Mon, 22 Jul 2024 07:29:19 -0700 Subject: [PATCH 3/4] typo --- docs/guides/releases.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/releases.md b/docs/guides/releases.md index c10a72d..30078ae 100644 --- a/docs/guides/releases.md +++ b/docs/guides/releases.md @@ -6,11 +6,11 @@ The projects maintained by the Ansible dev tools team have a target release freq One person within the devtools team will act as "release manager" each month. This will ensure each project is reviewed to ensure a release for that month was made. If a particular project's CI tests are failing, the project maintainer will work with the release manager to clear the block. If a project already has a release within the current month a new release is not necessary unless there are merged PRs and release notes available for a new release. -The following project should be release first, in no particular order: +The following project should be released first, in no particular order: - [ansible-compat](https://github.com/ansible/ansible-compat/releases) -The following projects should be release second, in no particular order: +The following projects should be released second, in no particular order: - [ansible-creator](https://github.com/ansible/ansible-creator/releases) - [ansible-dev-environment](https://github.com/ansible/ansible-dev-environment/releases) From 76e080f2eb1b268c21a2bce64c9c3b86026b0a74 Mon Sep 17 00:00:00 2001 From: "Bradley A. Thornton" Date: Mon, 22 Jul 2024 07:51:43 -0700 Subject: [PATCH 4/4] date fix --- docs/guides/releases.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/releases.md b/docs/guides/releases.md index 30078ae..df428c9 100644 --- a/docs/guides/releases.md +++ b/docs/guides/releases.md @@ -66,7 +66,7 @@ Completed date: Notes: -### 2024-08 +### 2024-07 Release manager: @alisonlhart