feat: add ci to publish to Puppet forge and linter checks

Author: lvicainne

.github/workflows/deploy.yaml

@@ -0,0 +1,23 @@
+name: Build and publish to Puppet Forge
+
+on:
+ push:
+  tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Get latest tag
+      id: vars
+      run: echo "{tag}=${GITHUB_REF:10}" >> $GITHUB_OUTPUT
+    - name: Clone repository
+      uses: actions/checkout@v4.1.1
+      with:
+        ref: ${{ steps.vars.outputs.tag }}
+    - name: Build and publish module
+      uses: barnumbirr/action-forge-publish@v2.15.0
+      env:
+       FORGE_API_KEY: ${{ secrets.FORGE_API_KEY }}
+       REPOSITORY_URL: https://forgeapi.puppet.com/v3/releases

.github/workflows/puppet-lint.yml

@@ -1,55 +1,17 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# Puppet Lint tests Puppet code against the recommended Puppet language style guide.
-# https://puppet.com/docs/puppet/7/style_guide.html
-# Puppet Lint validates only code style; it does not validate syntax.
-# To test syntax, use Puppet's puppet parser validate command.
-# More details at https://github.com/puppetlabs/puppet-lint/
+name: Puppet Lint
 
-name: puppet-lint
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "main" ]
-  schedule:
-    - cron: '27 0 * * 4'
-
-permissions:
-  contents: read
+on: [push]
 
 jobs:
   puppet-lint:
-    name: Run puppet-lint scanning
+
     runs-on: ubuntu-latest
-    permissions:
-      contents: read # for checkout to fetch code
-      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
-      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
-        with:
-          ruby-version: 2.7
-          bundler-cache: true
-
-      - name: Install puppet-lint
-        run: gem install puppet-lint
-
-      - name: Run puppet-lint
-        run: puppet-lint . --sarif > puppet-lint-results.sarif
-        continue-on-error: true
+    - name: Checkout
+      uses: actions/checkout@v4
 
-      - name: Upload analysis results to GitHub
-        uses: github/codeql-action/upload-sarif@v3
-        with:
-          sarif_file: puppet-lint-results.sarif
-          wait-for-processing: true
+    - name: puppet-lint
+      uses: scottbrenner/puppet-lint-action@v1.0.7
+      with:
+        args: ./manifests

CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+
+## v0.4.2 - Compatible with Puppet from 6.24 up to, but not including, 8.0
+
+### What's Changed
+
+* Lookup osfamily for RedHat clones by @msalway in <https://github.com/lvicainne/puppet-opendkim/pull/43>
+* Missing Optional for autorestart by @msalway in <https://github.com/lvicainne/puppet-opendkim/pull/44>
+* chore: update module version and metadata by @parveenk27 in <https://github.com/lvicainne/puppet-opendkim/pull/54>
+* Chunking publickey in 255 char blocks for dns txt by @cruelsmith in <https://github.com/lvicainne/puppet-opendkim/pull/51>
+* Add SignHeaders From by @seriv in <https://github.com/lvicainne/puppet-opendkim/pull/48>
+* feat(pdk): enable pdk to improve test and reliability of the module by @lvicainne in <https://github.com/lvicainne/puppet-opendkim/pull/55>
+
+### New Contributors
+
+* @parveenk27 made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/54>
+* @seriv made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/48>
+
+**Full Changelog**: <https://github.com/lvicainne/puppet-opendkim/compare/v0.4.0...v0.4.2>
+
+## v0.4.0
+
+### What's Changed
+
+* Add Missing Socket for Ubuntu 16.04 by @HielkeJ in <https://github.com/lvicainne/puppet-opendkim/pull/3>
+* Replace deprecated stdlib functions with puppet data types by @jkroepke in <https://github.com/lvicainne/puppet-opendkim/pull/5>
+* Removed full path comments on configfile by @jkroepke in <https://github.com/lvicainne/puppet-opendkim/pull/6>
+* Adding nameserver config paramter by @jkroepke in <https://github.com/lvicainne/puppet-opendkim/pull/7>
+* if you default it to undef in params, you need to make it Optional to acce… by @qs5779 in <https://github.com/lvicainne/puppet-opendkim/pull/8>
+* add force to directory absent resources by @qs5779 in <https://github.com/lvicainne/puppet-opendkim/pull/9>
+* Add parameters: mode, canonicalization, removeoldsignatures by @sa5bke in <https://github.com/lvicainne/puppet-opendkim/pull/12>
+* Add support for MaximumSignedBytes by @tetsuo13 in <https://github.com/lvicainne/puppet-opendkim/pull/13>
+* Make sure to create users before package installation by @Arakmar in <https://github.com/lvicainne/puppet-opendkim/pull/14>
+* Allow handling of private keys outsite puppet by @jeebiq in <https://github.com/lvicainne/puppet-opendkim/pull/18>
+* Test bumping version by @cFire in <https://github.com/lvicainne/puppet-opendkim/pull/17>
+* add ability to validate dnssec by @tobiWu in <https://github.com/lvicainne/puppet-opendkim/pull/19>
+* Fix duplicate resource if multiple keys are added for a domain by @nikdoof in <https://github.com/lvicainne/puppet-opendkim/pull/16>
+* make trustanchorfile optional by @antondollmaier in <https://github.com/lvicainne/puppet-opendkim/pull/20>
+* Add support for FreeBSD by @smortex in <https://github.com/lvicainne/puppet-opendkim/pull/21>
+* Add management of /etc/tmpfiles.d/opendkim.conf for RedHat by @razorbladex401 in <https://github.com/lvicainne/puppet-opendkim/pull/22>
+* Allow to apply a DKIM cert on all domains by @kapouik in <https://github.com/lvicainne/puppet-opendkim/pull/24>
+* Allow stdlib v8 by @sazzle2611 in <https://github.com/lvicainne/puppet-opendkim/pull/25>
+* Allow private keys to be Deferred for use with node_encrypt by @msalway in <https://github.com/lvicainne/puppet-opendkim/pull/28>
+* Add SenderHeaders option to opendkim.conf by @tallenaz in <https://github.com/lvicainne/puppet-opendkim/pull/29>
+* Fix legacy fact usage by @smortex in <https://github.com/lvicainne/puppet-opendkim/pull/30>
+* Adds Parameters to support 2048 bit keys and Specifying hash_algorithms by @razorbladex401 in <https://github.com/lvicainne/puppet-opendkim/pull/31>
+* Rework module to hiera and epp templates by @cruelsmith in <https://github.com/lvicainne/puppet-opendkim/pull/35>
+* chore(puppet): update module version and metadata by @lvicainne in <https://github.com/lvicainne/puppet-opendkim/pull/36>
+* Fix default value for sysconfigfile by @smortex in <https://github.com/lvicainne/puppet-opendkim/pull/37>
+* Edit file ownership and permissions by @tallenaz in <https://github.com/lvicainne/puppet-opendkim/pull/41>
+* Add autorestart config by @coreone in <https://github.com/lvicainne/puppet-opendkim/pull/42>
+
+## New Contributors
+
+* @HielkeJ made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/3>
+* @jkroepke made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/5>
+* @qs5779 made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/8>
+* @sa5bke made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/12>
+* @tetsuo13 made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/13>
+* @Arakmar made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/14>
+* @jeebiq made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/18>
+* @cFire made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/17>
+* @tobiWu made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/19>
+* @nikdoof made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/16>
+* @antondollmaier made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/20>
+* @smortex made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/21>
+* @razorbladex401 made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/22>
+* @kapouik made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/24>
+* @sazzle2611 made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/25>
+* @tallenaz made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/29>
+* @coreone made their first contribution in <https://github.com/lvicainne/puppet-opendkim/pull/42>
+
+**Full Changelog**: <https://github.com/lvicainne/puppet-opendkim/commits/v0.4.0>

README.md

@@ -34,27 +34,27 @@ Warning : this package will replace all your RSA keys ! Before using it, be sure
 A basic example is as follows:
 
 ```puppet
-  class { '::opendkim':
-    socket        => 'inet:8891@127.0.0.1',
-    trusted_hosts => ['::1','127.0.0.1','localhost'],
-    keys          => [
-        { 
-            domain         => 'mydomain.com',
-            selector       => 'default',
-            publickey      => 'p=yourPublicKey',
-            privatekey     => 'Your Private Key',
-            signingdomains => ['*@mydomain.com', '*@subdomain.mydomain.com'],
-        }
-    ]
-  }
+class { '::opendkim':
+  socket        => 'inet:8891@127.0.0.1',
+  trusted_hosts => ['::1','127.0.0.1','localhost'],
+  keys          => [
+      { 
+          domain         => 'mydomain.com',
+          selector       => 'default',
+          publickey      => 'p=yourPublicKey',
+          privatekey     => 'Your Private Key',
+          signingdomains => ['*@mydomain.com', '*@subdomain.mydomain.com'],
+      }
+  ]
+}
 ```
 
 ## Usage
 
 You can also use natively Hiera :
 
 ```puppet
-  include ::opendkim
+include ::opendkim
 ```
 
 ```yaml
@@ -152,46 +152,3 @@ This module has only been tested on my Debian and Centos servers. I can not guar
 ## Development
 
 You are pleased to fork this module and adapt it for you needs. I am open to any Pull Request :-)
-
-## Release Notes/Contributors/Etc
-
-### v0.4 - Compatible with Puppet from 6.24 up to, but not including, 8.0
-
-* v0.4.2  Add PDK dependancies
-          Add SignHeaders From
-          Chunking publickey in 255 char blocks for dns txt
-* v0.4.1  Fix version in metadata.json
-* v0.4.0  Add autorestart config
-          Lookup for OS Family facts in Hiera
-          Use var opendkim::user as the owner of files
-          Fix: Set default value for var opendkim::sysconfigfile
-          Set show_diff to false for all private key resources
-
-### v0.3 - Compatible with Puppet from 6.4 to newer
-
-* v0.3.0 Correct a bug about an optional parameter
-
-### v0.2 - Compatible with Puppet from 4.8 to 6.3
-
-* v0.2.9 Correct a bug about an optional parameter
-* v0.2.8 Add features from Pull Requests
-* v0.2.7 Add parameter maximum_signed_bytes
-* v0.2.6 Add parameters: mode, canonicalization, removeoldsignatures
-* v0.2.5 Make uid and gid not required any more to be defined
-* v0.2.4 Correction of the default directory for CentOs : from /etc/dkim to /etc/opendkim 
-* v0.2.3 Minor changes and corrections about empty values
-
-### v0.1 - Compatible with Puppet up to 4.6
-
-* v0.1.2 Virtual version (same as v0.1.0 but with bugfix about requirements and puppet version required)
-* v0.1.1 Use newer implementations of Puppet (v4.8 and newer). 
-* v0.1.0 Replace deprecated stdlib functions with puppet data types
-* v0.0.9 Correct some dependencies
-* v0.0.8 Closes #1 (SystemD with inline comments)
-* v0.0.7 Rename repository
-* v0.0.6 Support Umask variabilization in order to use UNIX sockets
-* v0.0.5 Add the homedir parameter
-* v0.0.4 Ensure the pidfile directory exists
-* v0.0.3 Improve some documentation parts
-* v0.0.2 Improve some documentation parts
-* v0.0.1 First Running version

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "lvicainne-opendkim",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "author": "lvicainne,cruelsmith",
   "summary": "Manage an OpenDKIM configuration",
   "license": "Apache-2.0",