Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize readme badges across all repos #99

Open
JohnRoesler opened this issue Feb 12, 2019 · 2 comments
Open

Standardize readme badges across all repos #99

JohnRoesler opened this issue Feb 12, 2019 · 2 comments

Comments

@JohnRoesler
Copy link
Contributor

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

@josephholsten
Copy link
Contributor

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)

@josephholsten
Copy link
Contributor

josephholsten commented Feb 12, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants