-
Notifications
You must be signed in to change notification settings - Fork 144
ansible core documentation release checklist
Our work for an upcoming release starts when a new stable branch is created for the upcoming ansible-core
release. Since we have to touch multiple releases, this means that:
- Most changes start in the
devel
branch and get backported to the new stable branch for the upcoming release. - Some changes to support the version switcher have to be backported to all maintained releases.
- One set of changes has to happen in the newly EOL’d branch.
To make this clear in the instructions below, we’ll use the following conventions:
-
stable-NEW
- reflects the newly created stable branch for the upcoming release. -
stable-NEW-1
andstable-NEW-2
- reflects the two prior releases that will continue to be maintained. -
stable-EOL
- the release before stable-NEW-2 that will go EOL once stable-NEW is released.
So for example, for ansible-core 2.14
release:
-
stable-NEW
isstable-2.14
(the newly created branch) -
stable-NEW-1
isstable-2.13
, andstable-NEW-2
isstable-2.12
-
stable-EOL
isstable-2.11
.
Create a tracking issue at https://github.com/ansible/ansible/issues similar to the core-2.14 checklist. The following steps go into more detail on the checklist items tracked in that issue.
- Review changelogs in
stable-NEW
in thechangelogs/changelog.rst
file. This is just a general scan to ensure it's a well-formed RST file. We do not edit changelogs as it requires finding the appropriate fragment and editing that instead of this generated file. This generated file may not appear until the first release candidate is created. - Review the core porting guide (at docs/docsite/rst/porting_guide/porting_guide_
NEW
.rst) as follows:- Ensure it links to
stable-NEW
changelogs reviewed in the prior step. - Ensure it is included at the top of docs/docsite/rst/porting_guides/core_porting_guides.rst file.
- Review for style/grammar. This is a light review for readability, etc.
- Ensure it links to
- Update release_and_maintenance.rst as follows:
This Wiki is used for quick notes, not for support or documentation.
Working groups are now in the Ansible forum
Ansible project:
Community,
Contributor Experience,
Docs,
News,
Outreach,
RelEng,
Testing
Cloud:
AWS,
Azure,
CloudStack,
Container,
DigitalOcean,
Docker,
hcloud,
Kubernetes,
Linode,
OpenStack,
oVirt,
Virt,
VMware
Networking:
ACI,
AVI,
F5,
Meraki,
Network,
NXOS
Ansible Developer Tools:
Ansible-developer-tools
Software:
Crypto,
Foreman,
GDrive,
GitLab,
Grafana,
IPA,
JBoss,
MongoDB,
MySQL,
PostgreSQL,
RabbitMQ,
Zabbix
System:
AIX,
BSD,
HP-UX,
macOS,
Remote Management,
Solaris,
Windows
Security:
Security-Automation,
Lockdown
Tooling:
AWX,
Galaxy,
Molecule
Plugins:
httpapi