feat: Update workflows (#90)

Add Renovate, Gemfile, and Rakefile standard fixes Add publish and lint-unit workflows Signed-off-by: Dan Webb <[email protected]>
test-kitchen · Nov 28, 2023 · 6470675 · 6470675
1 parent 09746dc
commit 6470675
Show file tree

Hide file tree

Showing 14 changed files with 161 additions and 119 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,7 +1,8 @@
+---
 version: 2
 updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,9 @@
+---
+name: "Lint, Unit & Integration Tests"
+
+"on":
+  pull_request:
+
+jobs:
+  lint-unit:
+    uses: test-kitchen/.github/.github/workflows/[email protected]
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -0,0 +1,35 @@
+---
+name: release-please
+
+"on":
+  push:
+    branches: [main]
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: kitchen-dsc
+          version-file: lib/kitchen-dsc/version.rb
+          token: ${{ secrets.PORTER_GITHUB_TOKEN }}
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        if: ${{ steps.release.outputs.release_created }}
+
+      - name: Build and publish to GitHub Package
+        uses: actionshub/publish-gem-to-github@main
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          owner: ${{ secrets.OWNER }}
+
+      - name: Build and publish to RubyGems
+        uses: actionshub/publish-gem-to-rubygems@main
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          token: ${{ secrets.RUBYGEMS_API_KEY }}
diff --git a/.gitignore b/.gitignore
@@ -9,7 +9,6 @@ Gemfile.lock
 *.gem
 .bundle
 .config
-.rubocop.yml
 coverage
 InstalledFiles
 lib/bundler/man

diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,9 @@
+---
+default: true
+MD013: false
+MD024: false
+MD026: false
+MD036: false
+MD012: false
+MD029: false
+MD004: false
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,11 @@
+---
+require:
+  - chefstyle
+
+AllCops:
+  TargetRubyVersion: 3.1
+  Include:
+    - "**/*.rb"
+  Exclude:
+    - "vendor/**/*"
+    - "spec/**/*"
diff --git a/.travis.yml b/.travis.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Change Log
 
 ## [v0.11.1](https://github.com/test-kitchen/kitchen-dsc/tree/v0.11.1) (2020-08-21)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.11.0...v0.11.1)
 
 **Merged pull requests:**
@@ -15,13 +16,15 @@
 - Optimize our requires [\#51](https://github.com/test-kitchen/kitchen-dsc/pull/51) ([tas50](https://github.com/tas50))
 
 ## [v0.11.0](https://github.com/test-kitchen/kitchen-dsc/tree/v0.11.0) (2017-09-29)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.10.1...v0.11.0)
 
 **Merged pull requests:**
 
 - Ability to run multiple dsc configurations [\#33](https://github.com/test-kitchen/kitchen-dsc/pull/33) ([TraGicCode](https://github.com/TraGicCode))
 
 ## [v0.10.1](https://github.com/test-kitchen/kitchen-dsc/tree/v0.10.1) (2017-07-05)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.10.0...v0.10.1)
 
 **Merged pull requests:**
@@ -30,81 +33,95 @@
 - Output mof generation errors [\#28](https://github.com/test-kitchen/kitchen-dsc/pull/28) ([elmundio87](https://github.com/elmundio87))
 
 ## [v0.10.0](https://github.com/test-kitchen/kitchen-dsc/tree/v0.10.0) (2016-06-24)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.9.3...v0.10.0)
 
 **Merged pull requests:**
 
 - Extract DSC LCM Configuration To Separate Gem [\#25](https://github.com/test-kitchen/kitchen-dsc/pull/25) ([smurawski](https://github.com/smurawski))
 
 ## [v0.9.3](https://github.com/test-kitchen/kitchen-dsc/tree/v0.9.3) (2016-06-23)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.9.2...v0.9.3)
 
 **Merged pull requests:**
 
 - Fix Duplicate Repository Params from metadata [\#24](https://github.com/test-kitchen/kitchen-dsc/pull/24) ([smurawski](https://github.com/smurawski))
 
 ## [v0.9.2](https://github.com/test-kitchen/kitchen-dsc/tree/v0.9.2) (2016-06-20)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.9.0...v0.9.2)
 
 **Merged pull requests:**
 
 - Silence all progress [\#21](https://github.com/test-kitchen/kitchen-dsc/pull/21) ([smurawski](https://github.com/smurawski))
 
 ## [v0.9.0](https://github.com/test-kitchen/kitchen-dsc/tree/v0.9.0) (2016-06-17)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.8.3...v0.9.0)
 
 **Merged pull requests:**
 
 - Support reboots [\#19](https://github.com/test-kitchen/kitchen-dsc/pull/19) ([smurawski](https://github.com/smurawski))
 
 ## [v0.8.3](https://github.com/test-kitchen/kitchen-dsc/tree/v0.8.3) (2016-05-16)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.8.2...v0.8.3)
 
 **Merged pull requests:**
 
 - Remove duplicate -Repository parameter [\#16](https://github.com/test-kitchen/kitchen-dsc/pull/16) ([brantb](https://github.com/brantb))
 
 ## [v0.8.2](https://github.com/test-kitchen/kitchen-dsc/tree/v0.8.2) (2016-04-01)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.8.1...v0.8.2)
 
 ## [v0.8.1](https://github.com/test-kitchen/kitchen-dsc/tree/v0.8.1) (2016-04-01)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.8.0...v0.8.1)
 
 ## [v0.8.0](https://github.com/test-kitchen/kitchen-dsc/tree/v0.8.0) (2016-03-31)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.7.0...v0.8.0)
 
 **Merged pull requests:**
 
 - Psgallery support [\#14](https://github.com/test-kitchen/kitchen-dsc/pull/14) ([smurawski](https://github.com/smurawski))
 
 ## [v0.7.0](https://github.com/test-kitchen/kitchen-dsc/tree/v0.7.0) (2016-03-28)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.6.1...v0.7.0)
 
 ## [v0.6.1](https://github.com/test-kitchen/kitchen-dsc/tree/v0.6.1) (2015-12-28)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.6.0...v0.6.1)
 
 **Merged pull requests:**
 
 - Fix a few typos [\#11](https://github.com/test-kitchen/kitchen-dsc/pull/11) ([smurawski](https://github.com/smurawski))
 
 ## [v0.6.0](https://github.com/test-kitchen/kitchen-dsc/tree/v0.6.0) (2015-12-18)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.5.0...v0.6.0)
 
 **Merged pull requests:**
 
 - Fail DSC run on error applying configuration. [\#10](https://github.com/test-kitchen/kitchen-dsc/pull/10) ([smurawski](https://github.com/smurawski))
 
 ## [v0.5.0](https://github.com/test-kitchen/kitchen-dsc/tree/v0.5.0) (2015-12-17)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.4.1...v0.5.0)
 
 **Merged pull requests:**
 
 - Support ConfigurationData in .kitchen.yml [\#9](https://github.com/test-kitchen/kitchen-dsc/pull/9) ([smurawski](https://github.com/smurawski))
 
 ## [v0.4.1](https://github.com/test-kitchen/kitchen-dsc/tree/v0.4.1) (2015-12-10)
+
 [Full Changelog](https://github.com/test-kitchen/kitchen-dsc/compare/v0.4.0...v0.4.1)
 
 ## [v0.4.0](https://github.com/test-kitchen/kitchen-dsc/tree/v0.4.0) (2015-12-10)
+
 **Merged pull requests:**
 
 - Smurawski/wmf5 prod preview [\#7](https://github.com/test-kitchen/kitchen-dsc/pull/7) ([smurawski](https://github.com/smurawski))
@@ -113,4 +130,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
diff --git a/Gemfile b/Gemfile
@@ -1,6 +1,24 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in kitchen-dsc.gemspec
 gemspec
 
-gem "github_changelog_generator"
+group :development do
+  gem "countloc", "~> 0.4"
+  gem "yard",      "~> 0.8"
+  gem "pry"
+  gem "pry-stack_explorer"
+  gem "pry-byebug"
+  gem "rb-readline"
+  gem "cane", "3.0.0"
+end
+
+group :test do
+  gem "rake"
+  gem "rspec",     "~> 3.2"
+  gem "simplecov", "~> 0.9"
+  gem "minitest",  "~> 5.3"
+end
+
+group :chefstyle do
+  gem "chefstyle", "2.2.3"
+end
diff --git a/README.md b/README.md
@@ -1,26 +1,32 @@
+# kitchen-dsc
+
 [![Gem Version](https://badge.fury.io/rb/kitchen-dsc.svg)](http://badge.fury.io/rb/kitchen-dsc)
 
-# kitchen-dsc
 A Test Kitchen Provisioner for PowerShell DSC
 
 ## Status
 
 This software project is no longer under active development as it has no active maintainers. The software may continue to work for some or all use cases, but issues filed in GitHub will most likely not be triaged. If a new maintainer is interested in working on this project please come chat with us in #test-kitchen on Chef Community Slack.
 
 ## Requirements
+
 You'll need a driver box with WMF4 or greater (ONLY WINDOWS SYSTEMS)
 
 ## Installation & Setup
-You'll need the test-kitchen & kitchen-dsc gems installed in your system, along with kitchen-vagrant or some ther suitable driver for test-kitchen. 
+
+You'll need the test-kitchen & kitchen-dsc gems installed in your system, along with kitchen-vagrant or some ther suitable driver for test-kitchen.
 
 ### Note:
+
 You will see a delay in the return of the run details due to an difference in how the verbose stream is returned for DSC runs between WMF versions, so I return the verbose stream after the job completes.  I'd love to live stream the results, but that'll take a bit more experimentation. (PR's welcome!)
 
 ## Example Configurations
+
 * [Repository Style Testing](https://github.com/smurawski/dsc-kitchen-project)
 * [Module Style Testing](https://github.com/powershellorg/cwebadministration/tree/smurawski/adding_tests)
 
 ## Configuration Settings
+
 * configuration_script_folder
   * Defaults to 'examples'.
   * The location of a PowerShell script(s) containing the DSC configuration command(s).
@@ -42,7 +48,7 @@ You will see a delay in the return of the run details due to an difference in ho
   * Can be defined in the configuration script or via the `configuration_data` configuration setting.
 
 * dsc_local_configuration_manager_version
-  * Defaults to 'wmf4' 
+  * Defaults to 'wmf4'
   * Identifies what version of the LCM is in place
   * Other valid values are 'wmf4_with_update' and 'wmf5'
     * Currently the only difference between wmf4 and wmf4_with_update/wmf5 is the action_after_reboot and the debug_mode settings.  Eventually, I'd like to add support for partial configurations, pull servers, etc..
@@ -64,8 +70,8 @@ You will see a delay in the return of the run details due to an difference in ho
 * modules_from_gallery
   * Requires WMF 5
   * Takes a string (for one module) or an array (for multiple) to install from the gallery
-  * Or takes a hash with keys matching the parameters for install-module.  
-    * Name is required.  
+  * Or takes a hash with keys matching the parameters for install-module.
+    * Name is required.
     * Force is automatically used and not required as part of the hash table.
     * Repository defaults to either PSGallery or any custom feed defined, but can be overriden here.
 
@@ -77,12 +83,13 @@ You will see a delay in the return of the run details due to an difference in ho
   * URI for a custom PowerShell gallery feed.
 
 ### Specific to repository style testing
+
 * modules_path
   * Defaults to 'modules'.
   * Points to the location of modules containing DSC resources to upload
   * This path is relative to the root of the repository (the location of the .kitchen.yml).
 
-## Example 
+## Example
 
 ```yaml
 provisioner: