Orb Badge
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://orb-badge.cci.feliciano.tech/<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://orb-badge.cci.feliciano.tech/circleci/aws-cli)](https://circleci.com/orbs/registry/orb/circleci/aws-cli)
Development
This server is written in Go. Please use Go v1.11 or later. It may work with earlier versions but it untested.
go get -u github.com/felicianotech/orb-badge
go run .
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://orb-badge.cci.feliciano.tech.
To run your own, in main.go
change the port to '80' or use a proxy.
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
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.