Skip to content

sgoings/travis-beacon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

travis-beacon

Goal

Provide the ability to place status/quality badges in READMEs within subdirectories of a repository which get their state from the repository's build job(s).

Summary

It would be really neat to show badges and shields on a per-chart basis within helm's charts repo. TravisCI (or any other CI system) doesn't yet support the concept of a badge-per-subproject, which is essentially what we're up to here. So... a sort of "shim" service is needed to bridge the gap between:

Then you can build an endpoint to the badge service which can query travis-beacon in more complex ways, such as in our case:

GET /charts/redis-standalone

Which can return a json object such as:

{
  "name": "redis-standalone",
  "lint": {
    "lint_score": 95
    "lint_failures": {
      "lint-picky-1": "lint-picky-1 description",
      "lint-serious-5", "lint-serious-5 description"
    }  
  }
  "e2e_pass": false
}

When something like the shields.io queries the travis-beacon service with that endpoint and parses the output, we can end up with a badge in the charts.git/redis-standalone/README.md that looks like:

helm-lint

Why the name?

A beacon is a device designed to attract attention to a specific location. In a similar way, this project provides users of particular helm charts more focused visibility to the level of quality for individual helm charts while surveying the charts repo.

There's also an amusing rhyme of travis-beacon with the product Mavis Beacon Teaches Typing. That connection is unintentional, but puns can always be stretched to find amusement...

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published