diff --git a/.config/dictionary.txt b/.config/dictionary.txt new file mode 100644 index 0000000..b111629 --- /dev/null +++ b/.config/dictionary.txt @@ -0,0 +1,4 @@ +alisonlhart +cidrblock +compat +pytest 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..df428c9 --- /dev/null +++ b/docs/guides/releases.md @@ -0,0 +1,75 @@ +# 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 released first, in no particular order: + +- [ansible-compat](https://github.com/ansible/ansible-compat/releases) + +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) +- [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-07 + +Release manager: @alisonlhart + +Completed date: 2024-07-18 + +Notes: