Skip to content

Commit

Permalink
Release notes (#200)
Browse files Browse the repository at this point in the history
* Release notes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* typo

* date fix

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
cidrblock and pre-commit-ci[bot] authored Jul 25, 2024
1 parent f4a2c0f commit de9c14c
Show file tree
Hide file tree
Showing 3 changed files with 103 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .config/dictionary.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
alisonlhart
cidrblock
compat
pytest
24 changes: 24 additions & 0 deletions cspell.config.yaml
Original file line number Diff line number Diff line change
@@ -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
75 changes: 75 additions & 0 deletions docs/guides/releases.md
Original file line number Diff line number Diff line change
@@ -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:

0 comments on commit de9c14c

Please sign in to comment.