simp / simp/puppetsync

Reconcile the Ruby Style (rubocop) job in the pr_tests.yml baseline — template and deployed modules have diverged

Open
#41 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
1
Forks
5
Avg merge
8d 1h
Merged PRs (30d)
4

Description

Problem

The Ruby Style (rubocop) job in the pupmod pr_tests.yml baseline is in an inconsistent state between the template and what is actually deployed to the modules.

Templatemodules/profile/files/pupmod/_github/workflows/pr_tests.yml:

  ruby-style:
    if: false # TODO Modules will need: rubocop in Gemfile, .rubocop.yml
    name: 'Ruby Style (experimental)'
    runs-on: ubuntu-latest
    continue-on-error: true

i.e. the job is disabled (if: false), marked experimental, and set to continue-on-error: true, pending modules having rubocop wired up.

Deployed modules — the job has drifted: it runs (no if: false, name 'Ruby Style') but still carries continue-on-error: true, so rubocop failures are silently ignored in CI. This is currently the case in ~70 of 71 non-archived pupmod-simp-* repos.

Why now

The round-2 OpenVox 9 / Ruby 4.0 migration standardized the rubocop stack across all modules (rubocop/-rake/-rspec now come via voxpupuli-test through simp-rake-helpers ~> 6.0, and every module has a .rubocop.yml). So the template's TODO precondition ("Modules will need: rubocop in Gemfile, .rubocop.yml") is now satisfied — rubocop can be a real, enforced check.

Ask

Decide the intended policy and reconcile the baseline so it matches, then resync:

  • Drop if: false and the (experimental) name, and remove continue-on-error: true so rubocop actually gates CI; or deliberately keep it advisory — but make the template and the deployed modules agree either way.

Related

Real rubocop failures currently masked by continue-on-error (to be fixed alongside enforcement):

  • simp/pupmod-simp-auditd#265
  • simp/pupmod-simp-deferred_resources#94
  • simp/pupmod-simp-iptables#167
  • simp/pupmod-simp-site#62
  • simp/pupmod-simp-haveged#84

Surfaced during the round-2 OpenVox 9 / Ruby 4.0 migration.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with modules/profile/files/pupmod/_github/workflows/pr_tests.yml and compare its Ruby Style job with the deployed module workflows described in the issue. Determine the intended advisory or enforced policy, update the baseline and resync it, then verify the generated workflows agree and the listed rubocop failures are handled alongside enforcement.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, ruby
Domain
ci-cd, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.