simp / simp/puppetsync

Remove dead Travis CI badges from module READMEs (69 repos)

Open
#47 0 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

Summary

69 repos still carry a dead Travis CI build badge in their top-level README.md. Travis has not run for SIMP in years, so every one of these renders as a broken or misleading build indicator — on the Forge-facing README that is often the first thing a user sees.

The line is perfectly uniform, with only the repo name interpolated:

[![Build Status](https://travis-ci.org/simp/<repo>.svg)](https://travis-ci.org/simp/<repo>)

Verified identical in pupmod-simp-aide, pupmod-simp-ssh, pupmod-simp-cron, pupmod-simp-simp_authselect, so a scripted sweep is safe.

⚠️ This is a scripted sweep, not a baseline-template change

Unlike #45 and #46, README.md is not a puppetsync-managed file. The managed set under
modules/profile/files/pupmod/ is Gemfile, _github/, _pdkignore, _puppet-lint.rc, and the
_rspec* variants — there is no README template. So this needs puppetsync to drive a
scripted per-repo edit and open PRs, rather than syncing a changed template. Worth being explicit
so nobody goes looking for a template that does not exist.

Two options for the replacement

Option A — just delete the line. Simplest, removes the dead badge, no new moving parts.

Option B — replace with a GitHub Actions badge:

[![PR Tests](https://github.com/simp/<repo>/actions/workflows/pr_tests.yml/badge.svg)](https://github.com/simp/<repo>/actions/workflows/pr_tests.yml)

No repo currently uses this, so it would be new across the board. Option B gives a real signal
but will honestly show red wherever master is failing — which today includes plenty of repos
(see the fleet-wide RPM release breakage). That is arguably the point of a badge, but it is a
visible change, so it deserves a deliberate decision rather than being slipped into a cleanup.

Do NOT touch these three

They matched the search but are vendored or fixture content and must be left alone:

  • simp/rubygem-simp-cliext/gems/highline/README.md (vendored gem)
  • simp/rubygem-simp-rake-helpersspec/lib/simp/rake/pupmod/fixtures/simpmod/README.md (test fixture)
  • simp/simp-adapterspec/fixtures/test_module_rpms/pupmod-simp-site/README.md (test fixture)

Adjacent README hygiene worth folding in

Two more copy-paste artifacts from the original module template, cheap to fix in the same pass:

  • The CII Best Practices badge is hardcoded to project 73 in every module — verified identical
    in aide, ssh, cron, and simp_authselect. It is one project's badge pasted fleet-wide, so it
    is wrong (or at least meaningless) on all but one repo. Decide whether to point it somewhere real
    or drop it.
  • 2 repos still carry the template's leftover instruction line
    **FIXME**: Ensure the badges are correct and complete, then remove this line! — one of them is
    pupmod-simp-simp_authselect, which is the entire content of
    simp/pupmod-simp-simp_authselect#3.

Closing that per-module issue in favor of this one would make sense once this lands.

Affected repos (69)

  • simp/pupmod-simp-acpid
  • simp/pupmod-simp-aide
  • simp/pupmod-simp-at
  • simp/pupmod-simp-auditd
  • simp/pupmod-simp-autofs
  • simp/pupmod-simp-clamav
  • simp/pupmod-simp-compliance_markup
  • simp/pupmod-simp-cron
  • simp/pupmod-simp-crypto_policy
  • simp/pupmod-simp-dconf
  • simp/pupmod-simp-deferred_resources
  • simp/pupmod-simp-dhcp
  • simp/pupmod-simp-ds389
  • simp/pupmod-simp-fips
  • simp/pupmod-simp-freeradius
  • simp/pupmod-simp-gdm
  • simp/pupmod-simp-gnome
  • simp/pupmod-simp-ima
  • simp/pupmod-simp-iptables
  • simp/pupmod-simp-issue
  • simp/pupmod-simp-krb5
  • simp/pupmod-simp-libreswan
  • simp/pupmod-simp-libvirt
  • simp/pupmod-simp-logrotate
  • simp/pupmod-simp-mate
  • simp/pupmod-simp-mockup
  • simp/pupmod-simp-named
  • simp/pupmod-simp-nfs
  • simp/pupmod-simp-oath
  • simp/pupmod-simp-oddjob
  • simp/pupmod-simp-openscap
  • simp/pupmod-simp-pam
  • simp/pupmod-simp-pki
  • simp/pupmod-simp-polkit
  • simp/pupmod-simp-postfix
  • simp/pupmod-simp-pupmod
  • simp/pupmod-simp-resolv
  • simp/pupmod-simp-rsync
  • simp/pupmod-simp-rsyslog
  • simp/pupmod-simp-selinux
  • simp/pupmod-simp-simp
  • simp/pupmod-simp-simp_apache
  • simp/pupmod-simp-simp_banners
  • simp/pupmod-simp-simp_ds389
  • simp/pupmod-simp-simp_firewalld
  • simp/pupmod-simp-simp_gitlab
  • simp/pupmod-simp-simp_grub
  • simp/pupmod-simp-simp_nfs
  • simp/pupmod-simp-simp_options
  • simp/pupmod-simp-simp_rsyslog
  • simp/pupmod-simp-simp_snmpd
  • simp/pupmod-simp-simpkv
  • simp/pupmod-simp-simplib
  • simp/pupmod-simp-ssh
  • simp/pupmod-simp-sssd
  • simp/pupmod-simp-stunnel
  • simp/pupmod-simp-sudo
  • simp/pupmod-simp-svckill
  • simp/pupmod-simp-swap
  • simp/pupmod-simp-tftpboot
  • simp/pupmod-simp-tlog
  • simp/pupmod-simp-tpm2
  • simp/pupmod-simp-tuned
  • simp/pupmod-simp-useradd
  • simp/pupmod-simp-vsftpd
  • simp/rubygem-simp-build-helpers
  • simp/rubygem-simp-rake-helpers
  • simp/simp-adapter
  • simp/simp-utils

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 by searching the top-level README.md files in the verified module examples and review puppetsync's managed files under modules/profile/files/pupmod/. Decide between deleting the Travis badge and using the proposed GitHub Actions badge, preserve the three excluded vendor or fixture files, and finish by driving the scripted edits and PRs for the affected repositories while resolving the CII and FIXME scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, ruby
Domain
ci-cd, documentation, tooling
Issue type
Documentation
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.