From 0d52d9089c4b5c7a3def1fb8832fd3eae6d97bfd Mon Sep 17 00:00:00 2001 From: Mike Riddle Date: Mon, 31 Jul 2023 20:36:43 -0400 Subject: [PATCH] Finalize RockyLinux 8 support (#49) --- .github/workflows/pr_tests.yml | 1 + .github/workflows/tag_deploy.yml | 3 +- .gitignore | 1 + .gitlab-ci.yml | 1 + REFERENCE.md | 116 +++++++++++++++++-------------- 5 files changed, 68 insertions(+), 54 deletions(-) diff --git a/.github/workflows/pr_tests.yml b/.github/workflows/pr_tests.yml index e4bc468..1780c4a 100644 --- a/.github/workflows/pr_tests.yml +++ b/.github/workflows/pr_tests.yml @@ -117,6 +117,7 @@ jobs: puppet_version: '~> 8.0' ruby_version: 3.1 experimental: true + fail-fast: false env: PUPPET_VERSION: ${{matrix.puppet.puppet_version}} steps: diff --git a/.github/workflows/tag_deploy.yml b/.github/workflows/tag_deploy.yml index 0e34b15..1185794 100644 --- a/.github/workflows/tag_deploy.yml +++ b/.github/workflows/tag_deploy.yml @@ -117,11 +117,10 @@ jobs: id: create_release env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - IS_PRERELEASE: ${{ steps.tag-check.outputs.prerelease }} run: | echo "${RELEASE_MESSAGE}" > /tmp/.commit-msg.txt args=(--file /tmp/.commit-msg.txt) - [[ $IS_PRERELEASE == yes ]] && args+=(--prerelease) + [[ ${{ steps.tag-check.outputs.prerelease }} == yes ]] && args+=(--prerelease) hub release create ${args[@]} "$TARGET_TAG" diff --git a/.gitignore b/.gitignore index 706aeb6..410b067 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,4 @@ dist /junit /log /doc +/Gemfile.lock diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index df5e065..2f158c3 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -340,6 +340,7 @@ pup7.pe-unit: <<: *pup_7_pe <<: *unit_tests +# Commenting until Puppet 8 is released #pup8.x-unit: # <<: *pup_8_x # <<: *unit_tests diff --git a/REFERENCE.md b/REFERENCE.md index 265db57..e386650 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -16,13 +16,13 @@ ### Defined types -* [`dconf::profile`](#dconfprofile): Updates a ``dconf`` profile entry to ``/etc/dconf/profile/$name`` -* [`dconf::settings`](#dconfsettings): Add a dconf rule to the profile of your choice This adds a configuration file to the /etc/dconf/db/.d directory. The dconf database +* [`dconf::profile`](#dconf--profile): Updates a ``dconf`` profile entry to ``/etc/dconf/profile/$name`` +* [`dconf::settings`](#dconf--settings): Add a dconf rule to the profile of your choice This adds a configuration file to the /etc/dconf/db/.d directory. The dconf database ### Data types -* [`Dconf::DBSettings`](#dconfdbsettings): Valid dconf database settings -* [`Dconf::SettingsHash`](#dconfsettingshash): Valid individual dconf settings +* [`Dconf::DBSettings`](#Dconf--DBSettings): Valid dconf database settings +* [`Dconf::SettingsHash`](#Dconf--SettingsHash): Valid individual dconf settings ## Classes @@ -34,16 +34,18 @@ Manage 'dconf' and associated entries The following parameters are available in the `dconf` class: -* [`user_profile`](#user_profile) -* [`user_settings`](#user_settings) -* [`package_ensure`](#package_ensure) -* [`use_user_profile_defaults`](#use_user_profile_defaults) -* [`user_profile_defaults_name`](#user_profile_defaults_name) -* [`user_profile_target`](#user_profile_target) -* [`use_user_settings_defaults`](#use_user_settings_defaults) -* [`user_settings_defaults_name`](#user_settings_defaults_name) +* [`user_profile`](#-dconf--user_profile) +* [`user_settings`](#-dconf--user_settings) +* [`package_ensure`](#-dconf--package_ensure) +* [`use_user_profile_defaults`](#-dconf--use_user_profile_defaults) +* [`user_profile_defaults_name`](#-dconf--user_profile_defaults_name) +* [`user_profile_target`](#-dconf--user_profile_target) +* [`use_user_settings_defaults`](#-dconf--use_user_settings_defaults) +* [`user_settings_defaults_name`](#-dconf--user_settings_defaults_name) +* [`tidy`](#-dconf--tidy) +* [`authselect`](#-dconf--authselect) -##### `user_profile` +##### `user_profile` Data type: `Dconf::DBSettings` @@ -51,15 +53,15 @@ The contents of the default user profile that will be added @see data/common.yaml -##### `user_settings` +##### `user_settings` Data type: `Optional[Dconf::SettingsHash]` Custom user settings that can be provided via Hiera globally -Default value: ``undef`` +Default value: `undef` -##### `package_ensure` +##### `package_ensure` Data type: `Simplib::PackageEnsure` @@ -69,15 +71,15 @@ The version of `dconf` to install Default value: `simplib::lookup('simp_options::package_ensure', { 'default_value' => 'installed' })` -##### `use_user_profile_defaults` +##### `use_user_profile_defaults` Data type: `Boolean` Add the default `user_profile` settings to the system -Default value: ``true`` +Default value: `true` -##### `user_profile_defaults_name` +##### `user_profile_defaults_name` Data type: `String[1]` @@ -86,7 +88,7 @@ The name that should be used for the custom `dconf::profile` in Default value: `'Defaults'` -##### `user_profile_target` +##### `user_profile_target` Data type: `String[1]` @@ -94,7 +96,7 @@ The name of the profile that should be targeted for the defaults Default value: `'user'` -##### `use_user_settings_defaults` +##### `use_user_settings_defaults` Data type: `Boolean` @@ -102,7 +104,7 @@ Enable creation of custom `dconf::settings` based on the `user_settings` Hash Default value: `$use_user_profile_defaults` -##### `user_settings_defaults_name` +##### `user_settings_defaults_name` Data type: `String[1]` @@ -111,9 +113,26 @@ the target profile for those settings Default value: `$user_profile_defaults_name` +##### `tidy` + +Data type: `Boolean` + +If set to true, any files in the profile directory that aren't managed by puppet +will be purged + +Default value: `true` + +##### `authselect` + +Data type: `Boolean` + + + +Default value: `simplib::lookup('simp_options::authselect', { 'default_value' => false })` + ## Defined types -### `dconf::profile` +### `dconf::profile` Updates a ``dconf`` profile entry to ``/etc/dconf/profile/$name`` @@ -125,25 +144,16 @@ Updates a ``dconf`` profile entry to ``/etc/dconf/profile/$name`` The following parameters are available in the `dconf::profile` defined type: -* [`name`](#name) -* [`target`](#target) -* [`entries`](#entries) -* [`target`](#target) -* [`base_dir`](#base_dir) +* [`name`](#-dconf--profile--name) +* [`entries`](#-dconf--profile--entries) +* [`target`](#-dconf--profile--target) +* [`base_dir`](#-dconf--profile--base_dir) -##### `name` +##### `name` A globally unique name for the entry -##### `target` - -Data type: `String[1]` - -The name of the profile file in ``base_dir`` - -Default value: `$name` - -##### `entries` +##### `entries` Data type: `Dconf::DBSettings` @@ -160,13 +170,15 @@ One or entries in the following Hash format: * System DB => Between 11 and 39 * Distro DB => 40 -##### `target` +##### `target` + +Data type: `String[1]` The target directory within which to create the profile Default value: `$name` -##### `base_dir` +##### `base_dir` Data type: `Stdlib::AbsolutePath` @@ -174,7 +186,7 @@ The base directory that will hold the resulting file Default value: `'/etc/dconf/profile'` -### `dconf::settings` +### `dconf::settings` Add a dconf rule to the profile of your choice @@ -186,12 +198,12 @@ lock a value so that general users cannot change it. The following parameters are available in the `dconf::settings` defined type: -* [`settings_hash`](#settings_hash) -* [`profile`](#profile) -* [`ensure`](#ensure) -* [`base_dir`](#base_dir) +* [`settings_hash`](#-dconf--settings--settings_hash) +* [`profile`](#-dconf--settings--profile) +* [`ensure`](#-dconf--settings--ensure) +* [`base_dir`](#-dconf--settings--base_dir) -##### `settings_hash` +##### `settings_hash` Data type: `Dconf::SettingsHash` @@ -208,15 +220,15 @@ each setting like in the exmaple Default value: `{}` -##### `profile` +##### `profile` Data type: `Optional[String[1]]` The dconf profile where you want to place the key/value. -Default value: ``undef`` +Default value: `undef` -##### `ensure` +##### `ensure` Data type: `Enum['present','absent']` @@ -224,7 +236,7 @@ Ensure the entire settings Hash is present or absent Default value: `'present'` -##### `base_dir` +##### `base_dir` Data type: `Stdlib::AbsolutePath` @@ -234,7 +246,7 @@ Default value: `'/etc/dconf/db'` ## Data types -### `Dconf::DBSettings` +### `Dconf::DBSettings` Valid dconf database settings @@ -247,7 +259,7 @@ Hash[String[1], Struct[{ }]] ``` -### `Dconf::SettingsHash` +### `Dconf::SettingsHash` Valid individual dconf settings