From fc114482b21f5d3009a3c509d3d85a48fa356b69 Mon Sep 17 00:00:00 2001 From: Aria Li Date: Thu, 24 Aug 2023 16:39:24 -0700 Subject: [PATCH] (maint) PDK Update 2.7.5 This commit updates and applies the 2.7.5 PDK template to prepare for the v1.15.0 release and make using the GitHub Changelog Generator easier. --- .github/workflows/auto_release.yml | 95 +++--------------------------- .github/workflows/release.yml | 44 +------------- .gitignore | 1 - .rubocop.yml | 7 +-- .sync.yml | 4 +- Gemfile | 14 ++--- Rakefile | 2 - metadata.json | 6 +- spec/default_facts.yml | 14 ----- 9 files changed, 25 insertions(+), 162 deletions(-) delete mode 100644 spec/default_facts.yml diff --git a/.github/workflows/auto_release.yml b/.github/workflows/auto_release.yml index a979d01c..501dc1ce 100644 --- a/.github/workflows/auto_release.yml +++ b/.github/workflows/auto_release.yml @@ -2,91 +2,14 @@ name: "Auto release" on: workflow_dispatch: - -env: - HONEYCOMB_WRITEKEY: 7f3c63a70eecc61d635917de46bea4e6 - HONEYCOMB_DATASET: litmus tests - CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + inputs: + version: + description: "Module version to be released. Must be a valid semver string. (1.2.3)" + required: true jobs: - auto_release: - name: "Automatic release prep" - runs-on: ubuntu-20.04 - - steps: - - - name: "Honeycomb: Start recording" - uses: puppetlabs/kvrhdn-gha-buildevents@pdk-templates-v1 - with: - apikey: ${{ env.HONEYCOMB_WRITEKEY }} - dataset: ${{ env.HONEYCOMB_DATASET }} - job-status: ${{ job.status }} - - - name: "Honeycomb: start first step" - run: | - echo STEP_ID="auto-release" >> $GITHUB_ENV - echo STEP_START=$(date +%s) >> $GITHUB_ENV - - name: "Checkout Source" - if: ${{ github.repository_owner == 'puppetlabs' }} - uses: actions/checkout@v3 - with: - fetch-depth: 0 - persist-credentials: false - - # We use the dev tools image here because the PDK image does not have the - # build tools necessary to compile native extensions. - - name: "PDK Release prep" - uses: docker://puppet/puppet-dev-tools:4.x - with: - args: 'pdk release prep --force --debug' - env: - CHANGELOG_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - - name: "Get Version" - if: ${{ github.repository_owner == 'puppetlabs' }} - id: gv - run: | - echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" - - - name: "Check if a release is necessary" - if: ${{ github.repository_owner == 'puppetlabs' }} - id: check - run: | - git diff --quiet CHANGELOG.md && echo "::set-output name=release::false" || echo "::set-output name=release::true" - - - name: "Commit changes" - if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} - run: | - git config --local user.email "${{ github.repository_owner }}@users.noreply.github.com" - git config --local user.name "GitHub Action" - git add . - git commit -m "Release prep v${{ steps.gv.outputs.ver }}" - - - name: Create Pull Request - id: cpr - uses: puppetlabs/peter-evans-create-pull-request@v3 - if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: "Release prep v${{ steps.gv.outputs.ver }}" - branch: "release-prep" - delete-branch: true - title: "Release prep v${{ steps.gv.outputs.ver }}" - body: | - Automated release-prep through [pdk-templates](https://github.com/puppetlabs/pdk-templates/blob/main/moduleroot/.github/workflows/auto_release.yml.erb) from commit ${{ github.sha }}. - Please verify before merging: - - [ ] last [nightly](https://github.com/${{ github.repository }}/actions/workflows/nightly.yml) run is green - - [ ] [Changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) is readable and has no unlabeled pull requests - - [ ] Ensure the [changelog](https://github.com/${{ github.repository }}/blob/release-prep/CHANGELOG.md) version and [metadata](https://github.com/${{ github.repository }}/blob/release-prep/metadata.json) version match - labels: "maintenance" - - - name: PR outputs - if: ${{ github.repository_owner == 'puppetlabs' && steps.check.outputs.release == 'true' }} - run: | - echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}" - echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}" - - - name: "Honeycomb: Record finish step" - if: ${{ always() }} - run: | - buildevents step $TRACE_ID $STEP_ID $STEP_START 'Finished auto release workflow' + release_prep: + uses: "puppetlabs/cat-github-actions/.github/workflows/module_release_prep.yml@main" + with: + version: "${{ github.event.inputs.version }}" + secrets: "inherit" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d9604ad6..0b7b8a05 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,44 +4,6 @@ on: workflow_dispatch: jobs: - create-github-release: - name: Deploy GitHub Release - runs-on: ubuntu-20.04 - steps: - - name: Checkout code - uses: actions/checkout@v3 - with: - ref: ${{ github.ref }} - clean: true - fetch-depth: 0 - - name: Get Version - id: gv - run: | - echo "::set-output name=ver::$(jq --raw-output .version metadata.json)" - - name: Create Release - uses: actions/create-release@v1 - id: create_release - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - with: - tag_name: "v${{ steps.gv.outputs.ver }}" - draft: false - prerelease: false - - deploy-forge: - name: Deploy to Forge - runs-on: ubuntu-20.04 - steps: - - name: Checkout code - uses: actions/checkout@v3 - with: - ref: ${{ github.ref }} - clean: true - - name: "PDK Build" - uses: docker://puppet/pdk:nightly - with: - args: 'build' - - name: "Push to Forge" - uses: docker://puppet/pdk:nightly - with: - args: 'release publish --forge-token ${{ secrets.FORGE_API_KEY }} --force' + release: + uses: "puppetlabs/cat-github-actions/.github/workflows/module_release.yml@main" + secrets: "inherit" diff --git a/.gitignore b/.gitignore index aea08564..988dcbbe 100644 --- a/.gitignore +++ b/.gitignore @@ -26,4 +26,3 @@ .envrc /inventory.yaml /spec/fixtures/litmus_inventory.yaml -.vscode/ diff --git a/.rubocop.yml b/.rubocop.yml index 3e18ee02..deacdc1c 100644 --- a/.rubocop.yml +++ b/.rubocop.yml @@ -37,7 +37,8 @@ Style/BlockDelimiters: be consistent then. EnforcedStyle: braces_for_chaining Style/ClassAndModuleChildren: - Enabled: false + Description: Compact style reduces the required amount of indentation. + EnforcedStyle: compact Style/EmptyElse: Description: Enforce against empty else clauses, but allow `nil` for clarity. EnforcedStyle: empty @@ -78,12 +79,8 @@ RSpec/MessageSpies: EnforcedStyle: receive Style/Documentation: Exclude: - - files/rb_task_helper.rb - lib/puppet/parser/functions/**/* - spec/**/* - - tasks/delete_local_filebucket.rb - - tasks/facts_diff.rb - - tasks/run.rb Style/WordArray: EnforcedStyle: brackets Performance/AncestorsInclude: diff --git a/.sync.yml b/.sync.yml index a7a257d7..09a0b685 100644 --- a/.sync.yml +++ b/.sync.yml @@ -41,8 +41,8 @@ Gemfile: condition: 'ENV["GEM_BOLT"]' - gem: async version: '~> 1.30' # otherwise async 2.0.0(needs ruby >=3.1.0) is wrongly selected by bundler on jenkins while running with ruby 2.7.1 - - gem: puppet_litmus - version: '0.34.5' + ":system_tests": + - gem: voxpupuli-acceptance appveyor.yml: delete: true .travis.yml: diff --git a/Gemfile b/Gemfile index 7261aaa7..033bd8e7 100644 --- a/Gemfile +++ b/Gemfile @@ -19,14 +19,14 @@ group :development do gem "json", '= 2.5.1', require: false if Gem::Requirement.create(['>= 3.0.0', '< 3.0.5']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.6.1', require: false if Gem::Requirement.create(['>= 3.1.0', '< 3.1.3']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) gem "json", '= 2.6.3', require: false if Gem::Requirement.create(['>= 3.2.0', '< 4.0.0']).satisfied_by?(Gem::Version.new(RUBY_VERSION.dup)) - gem "voxpupuli-puppet-lint-plugins", '~> 3.1', require: false + gem "voxpupuli-puppet-lint-plugins", '~> 4.0', require: false gem "facterdb", '~> 1.18', require: false gem "metadata-json-lint", '>= 2.0.2', '< 4.0.0', require: false - gem "puppetlabs_spec_helper", '>= 3.0.0', '< 5.0.0', require: false + gem "puppetlabs_spec_helper", '~> 5.0', require: false gem "rspec-puppet-facts", '~> 2.0', require: false gem "codecov", '~> 0.2', require: false gem "dependency_checker", '~> 0.2', require: false - gem "parallel_tests", '~> 3.4', require: false + gem "parallel_tests", '= 3.12.1', require: false gem "pry", '~> 0.10', require: false gem "simplecov-console", '~> 0.5', require: false gem "puppet-debugger", '~> 1.0', require: false @@ -42,8 +42,8 @@ group :development do gem "beaker-rspec" gem "beaker-puppet", *location_for(ENV['BEAKER_PUPPET_VERSION'] || '~> 1.22') gem "github_changelog_generator", '= 1.16.4', require: false - gem "concurrent-ruby", '= 1.1.10', require: false gem "beaker-module_install_helper", require: false + gem "concurrent-ruby", '= 1.1.10', require: false gem "beaker-puppet_install_helper", require: false gem "nokogiri", require: false gem "bolt", '~> 3.0', require: false if ENV["GEM_BOLT"] @@ -51,11 +51,9 @@ group :development do gem "async", '~> 1.30', require: false end group :system_tests do - # Pin Litmus to the last version that doens't pin r10k - # We need later versions of r10k for Ruby 3.2 compatibility - gem "puppet_litmus", '= 0.34.5', require: false, platforms: [:ruby, :x64_mingw] gem "serverspec", '~> 2.41', require: false - gem "voxpupuli-acceptance" + gem "puppet_litmus", '~> 1.0', require: false, platforms: [:ruby, :x64_mingw] + gem "voxpupuli-acceptance", require: false end puppet_version = ENV['PUPPET_GEM_VERSION'] diff --git a/Rakefile b/Rakefile index 66eff100..2e2066ee 100644 --- a/Rakefile +++ b/Rakefile @@ -4,10 +4,8 @@ require 'bundler' require 'puppet_litmus/rake_tasks' if Bundler.rubygems.find_name('puppet_litmus').any? require 'puppetlabs_spec_helper/rake_tasks' require 'puppet-syntax/tasks/puppet-syntax' -require 'puppet_blacksmith/rake_tasks' if Bundler.rubygems.find_name('puppet-blacksmith').any? require 'github_changelog_generator/task' if Bundler.rubygems.find_name('github_changelog_generator').any? require 'puppet-strings/tasks' if Bundler.rubygems.find_name('puppet-strings').any? -require 'voxpupuli/acceptance/rake' def changelog_user return unless Rake.application.top_level_tasks.include? "changelog" diff --git a/metadata.json b/metadata.json index f84a7d17..b7bdc190 100644 --- a/metadata.json +++ b/metadata.json @@ -75,7 +75,7 @@ "version_requirement": ">= 5.0.0 < 9.0.0" } ], - "pdk-version": "2.6.1", - "template-url": "https://github.com/puppetlabs/pdk-templates#main", - "template-ref": "heads/main-0-gf6adacf" + "pdk-version": "3.0.0", + "template-url": "https://github.com/puppetlabs/pdk-templates#2.7.5", + "template-ref": "tags/2.7.5-0-ge5b0114" } diff --git a/spec/default_facts.yml b/spec/default_facts.yml deleted file mode 100644 index 49175fab..00000000 --- a/spec/default_facts.yml +++ /dev/null @@ -1,14 +0,0 @@ - -# Use default_module_facts.yml for module specific facts. -# -# Facts specified here will override the values provided by rspec-puppet-facts. ---- -ipaddress: "172.16.254.254" -ipaddress6: "FE80:0000:0000:0000:AAAA:AAAA:AAAA" -is_pe: false -osfamily: 'Debian' -macaddress: "AA:AA:AA:AA:AA:AA" -pe_build: 2021.5.0 -identity: - user: root -