Merge pull request #46 from OpenVoxProject/release

Add Vox Pupuli CI defaults; configure release action & .gitignore: Exclude bundle vendor directories

Author: bastelfreak

.github/release.yml

@@ -1,8 +1,40 @@
+---
+# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes
+
 changelog:
+  exclude:
+    labels:
+      - duplicate
+      - invalid
+      - modulesync
+      - question
+      - skip-changelog
+      - wont-fix
+      - wontfix
+      - github_actions
+
   categories:
-    - title: Features & Enhancements
+    - title: Breaking Changes 🛠
+      labels:
+        - backwards-incompatible
+
+    - title: New Features 🎉
       labels:
         - enhancement
-    - title: Bug Fixes
+
+    - title: Bug Fixes 🐛
       labels:
         - bug
+
+    - title: Documentation Updates 📚
+      labels:
+        - documentation
+        - docs
+
+    - title: Dependency Updates ⬆️
+      labels:
+        - dependencies
+
+    - title: Other Changes
+      labels:
+        - "*"

.github/workflows/acceptance.yaml

@@ -1,3 +1,4 @@
+---
 name: Beaker Acceptance Tests
 run-name: |-
   Beaker acceptance tests for ${{ inputs.pre-release-build && 'pre-release' || 'release' }} package
@@ -47,7 +48,7 @@ env:
 jobs:
   acceptance:
     name: Acceptance Tests
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     strategy:
       matrix:
         os:

.github/workflows/backport.yml

@@ -1,3 +1,4 @@
+---
 name: Backport merged pull request
 on:
   pull_request_target:
@@ -8,7 +9,7 @@ permissions:
 jobs:
   backport:
     name: Backport merged pull request
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     # For security reasons, we don't want to checkout and run arbitrary code when
     # using the pull_request_target trigger. So restrict this to cases where the
     # backport label is applied to an already merged PR.

.github/workflows/build.yml

@@ -1,3 +1,4 @@
+---
 name: Build openvox-agent
 
 permissions:
@@ -25,4 +26,4 @@ jobs:
       ref: ${{ inputs.ref }}
       project_name: ${{ inputs.project_name }}
       platform_list: ${{ inputs.platform_list }}
-    secrets: inherit
+    secrets: inherit

.github/workflows/checks.yaml

@@ -1,3 +1,4 @@
+---
 name: Checks
 
 on:
@@ -12,8 +13,9 @@ permissions:
 jobs:
   rake_checks:
     name: Rake Checks
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
+      # needs fetch-depth because the packaging dem reads old git tags
       - name: Checkout current PR
         uses: actions/checkout@v4
         with:
@@ -22,8 +24,12 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.3
-      - name: Update rubygems and install gems
+          bundler-cache: true
+      - name: Validate code
         run: |
-          gem update --system --silent --no-document
-          bundle install --jobs 4 --retry 3
-      - run: bundle exec rake rubocop --trace
+          bundle exec rake rubocop
+          bundle exec rake -T | grep vox:build
+          bundle exec rake -T | grep vox:promote
+          bundle exec rake -T | grep vox:tag
+          bundle exec rake -T | grep vox:upload
+          bundle exec rake config:print

.gitignore

@@ -1,4 +1,5 @@
-vendor/*
+/vendor/*
+/.vendor/*
 output/*
 .bundle
 Gemfile.lock

.rubocop.yml

@@ -8,8 +8,12 @@ AllCops:
     - 'resources/**/*.rb'
     - 'ext/**/*'
     - 'vendor/**/*'
+    - '.vendor/**/*'
     - 'bundle/**/*'
 
+plugins:
+  - rubocop-rake
+
 Layout/ArgumentAlignment:
   Enabled: false
 

Gemfile

@@ -17,5 +17,6 @@ gem 'rake'
 gem 'json'
 gem 'octokit'
 gem 'rubocop', "~> 1.22"
+gem 'rubocop-rake'
 
 eval_gemfile("#{__FILE__}.local") if File.exist?("#{__FILE__}.local")

Rakefile

@@ -39,12 +39,12 @@ load './ext/release-lead.rake'
 
 Pkg::Util::RakeUtils.load_packaging_tasks
 
-desc 'run static analysis with rubocop'
-task(:rubocop) do
-  require 'rubocop'
-  cli = RuboCop::CLI.new
-  exit_code = cli.run(%w(--display-cop-names --format simple))
-  raise "RuboCop detected offenses" if exit_code != 0
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # These make the rubocop experience maybe slightly less terrible
+  task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
+  # Use Rubocop's Github Actions formatter if possible
+  task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
 end
 
 desc "verify that commit messages match CONTRIBUTING.md requirements"