sous-chefs/meta

Standardize readme badges across all repos

Opened this issue · 2 comments

Badges each readme should have:

  • The CircleCI test badge (readme text/code): [![CircleCI](https://circleci.com/gh/sous-chefs/<repo-name>/tree/master.svg?style=svg)](https://circleci.com/gh/sous-chefs/<repo-name>/tree/master)
  • The Supermarket cookbook latest release version badge (readme text/code): [![Cookbook Version](https://img.shields.io/cookbook/v/haproxy.svg)](https://supermarket.chef.io/cookbooks/haproxy)

An example of the badges:
image

An example of the readme: here

I really prefer the boring look of shields.io, and an example is in postgresql:

[![Cookbook Version](https://img.shields.io/cookbook/v/postgresql.svg)](https://supermarket.chef.io/cookbooks/postgresql)
[![Build Status](https://img.shields.io/circleci/project/github/sous-chefs/postgresql/master.svg)](https://circleci.com/gh/sous-chefs/postgresql)
[![pullreminders](https://pullreminders.com/badge.svg)](https://pullreminders.com?ref=badge)

how to find all the repos that don't have this:

  • install hub and ghq
  • import all the repos from sous-chefs:
hub api users/sous-chefs/repos | jq -r '.[].ssh_url' | ghq import -u 
  • check each readme contains https://img.shields.io/circleci/project/github/sous-chefs/
find . -name README.md |
xargs grep https://img.shields.io/circleci/project/github/sous-chefs/

That should list all README.md files that do contain the circleci badge.

There's probably a way to get the inverse: all files which to not contain a regex, but it's not a basic grep -v