Skip to content

Commit

Permalink
docs: denote supported ansible versions in cookie (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasPammer authored Apr 16, 2023
1 parent 77dc7a2 commit a7a1f14
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ rolename__somevar: "{{

=== GitHub
* Includes a Continuous GitHub *Workflow to `yamllint` / `ansiblelint` all files*
* Includes a Continuous GitHub *Workflow to run `molecule` test's on a matrix of different OS's* (with systemd support) *and Ansible versions*
* Includes a Continuous GitHub *Workflow to run `molecule` test's on a matrix of different distributions* (with systemd support) *and different Ansible versions*
* Includes a GitHub *Workflow to release to Ansible Galaxy*
+
[NOTE]
Expand Down
8 changes: 4 additions & 4 deletions {{ cookiecutter.project_slug }}/DEVELOPMENT.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,9 @@ takes care of importing the role to my Ansible Galaxy Account.
=== 🧪 Testing
Automatic Tests are run on each Contribution using GitHub Workflows.

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

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

Expand Down
72 changes: 72 additions & 0 deletions {{ cookiecutter.project_slug }}/README.orig.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,78 @@ vars:
====


[[tested-distributions]]
== 🧪 Tested Distributions

A role may work on different *distributions*, like Red Hat Enterprise Linux (RHEL),
even though there is no test for this exact distribution.

|===
| OS Family | Distribution | Distribution Release Date | Distribution End of Life | Accompanying Docker Image

| RedHat
| CentOS 7
| 2014-07
| 2024-06
| 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]]
(https://github.com/geerlingguy/docker-centos7-ansible/issues/18[*,title="CentOS 7 is old"])

| Rocky
| Rocky Linux 8 (https://www.howtogeek.com/devops/is-rocky-linux-the-new-centos/[RHEL/CentOS 8 in disguise])
| 2021-06
| 2029-05
| 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]]

| RedHat
| Fedora 35
| 2021-11
| 2022-11
| 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]]

| Debian
| Ubuntu 1604
| 2016-04
| 2026-04
| 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]]

| Debian
| Ubuntu 1804
| 2018-04
| 2028-04
| 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]]

| Debian
| Ubuntu 2004
| 2021-09
| 2030-04
| 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]]

| Debian
| Debian 10
| 2019-07
| 2022-08
| 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]]

| Debian
| Debian 11
| 2021-08
| ?
| 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]]
|===


[[tested-ansible-versions]]
== 🧪 Tested Ansible versions

The tested ansible versions try to stay equivalent with the
https://github.com/ansible-collections/community.general#tested-with-ansible[
support pattern of Ansible's `community.general` collection].
As of writing this is:

* 2.11 (Ansible 4)
* 2.12 (Ansible 5)


[[development]]
== 📝 Development
// Badges about Conventions in this Project
Expand Down

0 comments on commit a7a1f14

Please sign in to comment.