Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
tpl
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Orb Badge Server CircleCI Build Status GitHub License

Orb Badge is a mini Go server designed to provide a JSON endpoint for Shields.io's custom badges. This allows Orb developers to use a status badge on their repo's readme file.

This software is currently considered a proof of concept. It may go away, and it may break as the Shields.io service is in beta.

Using a Badge

You show an orb version status badge with the following URL:

https://img.shields.io/badge/endpoint.svg?url=https://badges.circleci.io/orb/<namespace>/<orb-name>

where <namespace> is your Orb's namespace and <orb-name> is the name of the specific Orb.

For example, here's a badge for the CircleCI AWS CLI Orb in Markdown with a link back to the Orbs page:

[![CircleCI Orb Version](https://img.shields.io/badge/endpoint.svg?url=https://badges.circleci.io/orb/circleci/aws-cli)](https://circleci.com/orbs/registry/orb/circleci/aws-cli)

and here is how it render's: CircleCI Orb Version

Development

Raw / Straight on local machine

This server is written in Go. Please use Go v1.11 or later. It may work with earlier versions but it's untested.

go get -u github.com/felicianotech/orb-badge
go run .

Docker

If you don't have Go installed locally or just want to use Docker regardless:

git clone https://github.com/felicianotech/orb-badge-server
cd orb-badge-server
docker build -it dev/orb-badge-server # will show the server running in the terminal and stay attached
docker build -it dev/orb-badge-server # will run the terminal in the background and return control

The server will be available at http://localhost:1107/.

Production

There really isn't a production server right now. I am running a test/beta at https://badges.circleci.io.

To run your own, place the binary on a server and run it. If you use port 80, sudo will be needed for non-root users.

go build ./...
./orb-badge <port>

Running the binary in something like tmux will make your life easier as well.

License

This repository is licensed under the MIT license. This repo's license can be found here.

About

Status badges for CircleCI Orbs.

Resources

Releases

No releases published
You can’t perform that action at this time.