Skip to content

Commit a7a1f14

Browse files
authored
docs: denote supported ansible versions in cookie (#88)
1 parent 77dc7a2 commit a7a1f14

File tree

3 files changed

+77
-5
lines changed

3 files changed

+77
-5
lines changed

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ rolename__somevar: "{{
5555

5656
=== GitHub
5757
* Includes a Continuous GitHub *Workflow to `yamllint` / `ansiblelint` all files*
58-
* Includes a Continuous GitHub *Workflow to run `molecule` test's on a matrix of different OS's* (with systemd support) *and Ansible versions*
58+
* Includes a Continuous GitHub *Workflow to run `molecule` test's on a matrix of different distributions* (with systemd support) *and different Ansible versions*
5959
* Includes a GitHub *Workflow to release to Ansible Galaxy*
6060
+
6161
[NOTE]

{{ cookiecutter.project_slug }}/DEVELOPMENT.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,9 @@ takes care of importing the role to my Ansible Galaxy Account.
4646
=== 🧪 Testing
4747
Automatic Tests are run on each Contribution using GitHub Workflows.
4848

49-
The Tests primarily resolve around running
50-
https://molecule.readthedocs.io/en/latest/[Molecule]
51-
on a varying set of linux distributions and using various ansible versions,
52-
as detailed in https://github.com/{{ cookiecutter.github_username }}/ansible-roles[{{ cookiecutter.github_username }}/ansible-roles].
49+
The Tests primarily resolve around running https://molecule.readthedocs.io/en/latest/[Molecule]
50+
on a <<tested-distributions,varying set of linux distributions>>
51+
and using <<tested-ansible-versions,various ansible versions>>.
5352

5453
The molecule test also includes a step which lints all ansible playbooks using
5554
https://github.com/ansible/ansible-lint#readme[`ansible-lint`]
@@ -119,6 +118,7 @@ You may also want to know that the files mentioned in the admonition above
119118
are attached to the *GitHub CI Artifacts* of a given Workflow run. +
120119
This allows one to check the difference between runs
121120
and thus help in debugging what caused the bit-rot or failure in general.
121+
122122
image::https://user-images.githubusercontent.com/32995541/178442403-e15264ca-433a-4bc7-95db-cfadb573db3c.png[]
123123
=====
124124

{{ cookiecutter.project_slug }}/README.orig.adoc

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,78 @@ vars:
161161
====
162162

163163

164+
[[tested-distributions]]
165+
== 🧪 Tested Distributions
166+
167+
A role may work on different *distributions*, like Red Hat Enterprise Linux (RHEL),
168+
even though there is no test for this exact distribution.
169+
170+
|===
171+
| OS Family | Distribution | Distribution Release Date | Distribution End of Life | Accompanying Docker Image
172+
173+
| RedHat
174+
| CentOS 7
175+
| 2014-07
176+
| 2024-06
177+
| https://github.com/geerlingguy/docker-centos7-ansible/actions?query=workflow%3ABuild[image:https://github.com/geerlingguy/docker-centos7-ansible/workflows/Build/badge.svg?branch=master[CI]]
178+
(https://github.com/geerlingguy/docker-centos7-ansible/issues/18[*,title="CentOS 7 is old"])
179+
180+
| Rocky
181+
| Rocky Linux 8 (https://www.howtogeek.com/devops/is-rocky-linux-the-new-centos/[RHEL/CentOS 8 in disguise])
182+
| 2021-06
183+
| 2029-05
184+
| https://github.com/geerlingguy/docker-rockylinux8-ansible/actions?query=workflow%3ABuild[image:https://github.com/geerlingguy/docker-rockylinux8-ansible/workflows/Build/badge.svg?branch=master[CI]]
185+
186+
| RedHat
187+
| Fedora 35
188+
| 2021-11
189+
| 2022-11
190+
| https://github.com/geerlingguy/docker-fedora35-ansible/actions?query=workflow%3ABuild[image:https://github.com/geerlingguy/docker-fedora35-ansible/workflows/Build/badge.svg?branch=master[CI]]
191+
192+
| Debian
193+
| Ubuntu 1604
194+
| 2016-04
195+
| 2026-04
196+
| https://github.com/geerlingguy/docker-ubuntu1604-ansible/actions?query=workflow%3ABuild[image:https://github.com/geerlingguy/docker-ubuntu1604-ansible/workflows/Build/badge.svg?branch=master[CI]]
197+
198+
| Debian
199+
| Ubuntu 1804
200+
| 2018-04
201+
| 2028-04
202+
| https://github.com/geerlingguy/docker-ubuntu1804-ansible/actions?query=workflow%3ABuild[image:https://github.com/geerlingguy/docker-ubuntu1804-ansible/workflows/Build/badge.svg?branch=master[CI]]
203+
204+
| Debian
205+
| Ubuntu 2004
206+
| 2021-09
207+
| 2030-04
208+
| https://github.com/geerlingguy/docker-ubuntu2004-ansible/actions?query=workflow%3ABuild[image:https://github.com/geerlingguy/docker-ubuntu2004-ansible/workflows/Build/badge.svg?branch=master[CI]]
209+
210+
| Debian
211+
| Debian 10
212+
| 2019-07
213+
| 2022-08
214+
| https://github.com/geerlingguy/docker-debian10-ansible/actions?query=workflow%3ABuild[image:https://github.com/geerlingguy/docker-debian10-ansible/workflows/Build/badge.svg?branch=master[CI]]
215+
216+
| Debian
217+
| Debian 11
218+
| 2021-08
219+
| ?
220+
| https://github.com/geerlingguy/docker-debian11-ansible/actions?query=workflow%3ABuild[image:https://github.com/geerlingguy/docker-debian11-ansible/workflows/Build/badge.svg?branch=master[CI]]
221+
|===
222+
223+
224+
[[tested-ansible-versions]]
225+
== 🧪 Tested Ansible versions
226+
227+
The tested ansible versions try to stay equivalent with the
228+
https://github.com/ansible-collections/community.general#tested-with-ansible[
229+
support pattern of Ansible's `community.general` collection].
230+
As of writing this is:
231+
232+
* 2.11 (Ansible 4)
233+
* 2.12 (Ansible 5)
234+
235+
164236
[[development]]
165237
== 📝 Development
166238
// Badges about Conventions in this Project

0 commit comments

Comments
 (0)