Added Changelog.

Updated collection README documentation.
trippsc2 · Jan 8, 2025 · d00920a · d00920a
1 parent 603f36a
commit d00920a
Show file tree

Hide file tree

Showing 7 changed files with 91 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.11] - 2025-01-08
+
+- Added Changelog.
+- Updated collection README documentation.
+
+## [1.0.10] - 2024-09-10
+
+- *trippsc2.first_steps.rhel* role - Removed the `rhel_subscription_pool` variable, as this is deprecated.
+
+## [1.0.9] - 2024-09-06
+
+- *trippsc2.first_steps.rhel* role - Added `no_log` option to `rhel_red_hat_password` variable.
+
+## [1.0.8] - 2024-08-09
+
+- Minimum Ansible version changed from `2.14` to `2.15` due to EOL status.
+
+## [1.0.7] - 2024-07-08
+
+- Updated manifest file to ensure that molecule tests are not included in releases.
+
+## [1.0.6] - 2024-07-07
+
+- *trippsc2.first_steps.debian* role - Removed steps to set the machine to a graphical target.
+- *trippsc2.first_steps.debian* role - Added the `debian_install_firewalld` and `debian_install_ssl_cert` variables to allow steps to install `firewalld` and `ssl-cert` pacakges to be enabled/disabled (enabled by default).
+- *trippsc2.first_steps.ubuntu* role - Removed steps to set the machine to a graphical target.
+- *trippsc2.first_steps.ubuntu* role - Added the `ubuntu_install_ssl_cert` variable to allow step to install `ssl-cert` pacakge to be enabled/disabled (enabled by default).
+
+## [1.0.5] - 2024-07-03
+
+- *trippsc2.first_steps.ubuntu* role - Added step to install the `ssl-cert` package.
+
+## [1.0.4] - 2024-07-03
+
+- *trippsc2.first_steps.debian* role - Added step to install the `ssl-cert` package.
+
+## [1.0.3] - 2024-07-02
+
+- *trippsc2.first_steps.debian* role - Added step to install the `gnupg` package.
+- *trippsc2.first_steps.ubuntu* role - Added step to install the `gnupg` package.
+
+## [1.0.2] - 2024-06-30
+
+- *trippsc2.first_steps.debian* role - Updated documentation and role metadata for readability.
+- *trippsc2.first_steps.rhel* role - Updated documentation and role metadata for readability.
+- *trippsc2.first_steps.ubuntu* role - Updated documentation and role metadata for readability.
+- *trippsc2.first_steps.ubuntu* role - Added step to remove the `unattended-upgrades` package that caused problems with Vagrant boxes.
+
+## [1.0.1] - 2024-06-13
+
+- *trippsc2.first_steps.debian* role - Updated documentation and role metadata for readability.
+- *trippsc2.first_steps.rhel* role - Updated documentation and role metadata for readability.
+- *trippsc2.first_steps.rhel* role - Removed step to install the `python36` package on EL 8.
+- *trippsc2.first_steps.ubuntu* role - Updated documentation and role metadata for readability.
+
+## [1.0.0] - 2024-06-11
+
+- Initial release.
+- *trippsc2.first_steps.debian* role - Role added.
+- *trippsc2.first_steps.rhel* role - Role added.
+- *trippsc2.first_steps.ubuntu* role - Role added.
diff --git a/README.md b/README.md
@@ -1,2 +1,11 @@
-# ansible-collection-first_steps
+# Ansible Collection: trippsc2.first_steps
+
 This collection contains roles for performing first steps on freshly deployed machines.
+
+## Content
+
+### Roles
+
+- [debian](roles/debian/README.md) - This role performs first steps on a freshly installed Debian system.
+- [rhel](roles/rhel/README.md) - This role performs first steps on a freshly installed RHEL-based system.
+- [ubuntu](roles/ubuntu/README.md) - This role performs first steps on a freshly installed Ubuntu system.
diff --git a/galaxy.yml b/galaxy.yml
@@ -1,15 +1,18 @@
 ---
 namespace: trippsc2
 name: first_steps
-version: 1.0.10
+version: 1.0.11
 readme: README.md
 authors:
   - Jim Tarpley
 description: This collection contains roles for performing first steps on freshly deployed machines.
 
 license_file: 'LICENSE'
 
-tags: []
+tags:
+  - infrastructure
+  - linux
+  - windows
 
 dependencies:
   ansible.posix: ">=1.0.0"

diff --git a/generate-docs.sh b/generate-docs.sh
@@ -2,12 +2,12 @@
 
 cd ./roles/debian
 
-aar_doc . markdown
+aar-doc . markdown
 
 cd ../rhel
 
-aar_doc . markdown
+aar-doc . markdown
 
 cd ../ubuntu
 
-aar_doc . markdown
+aar-doc . markdown
diff --git a/roles/debian/README.md b/roles/debian/README.md
@@ -1,7 +1,7 @@
 <!-- BEGIN_ANSIBLE_DOCS -->
 
 # Ansible Role: trippsc2.first_steps.debian
-Version: 1.0.10
+Version: 1.0.11
 
 This role performs first steps on a freshly installed Debian system.
 
@@ -20,8 +20,8 @@ This role performs first steps on a freshly installed Debian system.
 ## Role Arguments
 |Option|Description|Type|Required|Choices|Default|
 |---|---|---|---|---|---|
-| debian_install_firewalld | <p>Whether to install the firewalld package.</p> | bool | no |  | true |
-| debian_install_ssl_cert | <p>Whether to install the ssl-cert package.</p> | bool | no |  | true |
+| debian_install_firewalld | <p>Whether to install the firewalld package.</p> | bool | no |  | True |
+| debian_install_ssl_cert | <p>Whether to install the ssl-cert package.</p> | bool | no |  | True |
 
 
 ## License

diff --git a/roles/rhel/README.md b/roles/rhel/README.md
@@ -1,7 +1,7 @@
 <!-- BEGIN_ANSIBLE_DOCS -->
 
 # Ansible Role: trippsc2.first_steps.rhel
-Version: 1.0.10
+Version: 1.0.11
 
 This role performs first steps on a freshly installed RHEL-based system.
 
@@ -23,10 +23,10 @@ This role performs first steps on a freshly installed RHEL-based system.
 |---|---|---|---|---|---|
 | rhel_red_hat_username | <p>Red Hat subscription username.</p><p>Required for RHEL only.</p> | str | no |  |  |
 | rhel_red_hat_password | <p>Red Hat subscription password.</p><p>Required for RHEL only.</p> | str | no |  |  |
-| rhel_subscription_auto_attach | <p>Auto attach subscription.</p><p>Required for RHEL only.</p> | bool | no |  | false |
+| rhel_subscription_auto_attach | <p>Auto attach subscription.</p><p>Required for RHEL only.</p> | bool | no |  |  |
 | rhel_subscription_syspurpose_usage | <p>System purpose usage.</p><p>Required for RHEL only.</p> | str | no |  |  |
 | rhel_subscription_syspurpose_service_level_agreement | <p>System purpose service level agreement.</p><p>Required for RHEL only.</p> | str | no |  |  |
-| rhel_subscription_syspurpose_sync | <p>System purpose sync.</p><p>Required for RHEL only.</p> | bool | no |  | false |
+| rhel_subscription_syspurpose_sync | <p>System purpose sync.</p><p>Required for RHEL only.</p> | bool | no |  |  |
 
 
 ## License

diff --git a/roles/ubuntu/README.md b/roles/ubuntu/README.md
@@ -1,7 +1,7 @@
 <!-- BEGIN_ANSIBLE_DOCS -->
 
 # Ansible Role: trippsc2.first_steps.ubuntu
-Version: 1.0.10
+Version: 1.0.11
 
 This role performs first steps on a freshly installed Ubuntu system.
 
@@ -20,7 +20,7 @@ This role performs first steps on a freshly installed Ubuntu system.
 ## Role Arguments
 |Option|Description|Type|Required|Choices|Default|
 |---|---|---|---|---|---|
-| ubuntu_install_ssl_cert | <p>Whether to install the ssl-cert package.</p> | bool | no |  | true |
+| ubuntu_install_ssl_cert | <p>Whether to install the ssl-cert package.</p> | bool | no |  | True |
 
 
 ## License