badger

Heavily inspired by:

• https://github.com/badges/shields
• https://github.com/HandOfGod94/jacoco-cov-badge-maven-plugin

Dynamically build badges based on specified properties

library

package

Maven installation

1. Add the following to your global ~/.m2/settings.xml:

<profiles>
  <profile>
    <id>github</id>
      <repositories>
        <repository>
          <id>github</id>
          <name>peppys badger github repo</name>
          <url>https://maven.pkg.github.com/peppys/badger</url>
        </repository>
      </repositories>
  </profile>
</profiles>

<servers>
  <server>
    <id>github</id>
    <username>{GITHUB_USER}</username>
    <password>{GITHUB_TOKEN}</password>
  </server>
</servers>

2. Add the following depency to your pom.xml

<dependency>
  <groupId>io.github.peppys</groupId>
  <artifactId>badger</artifactId>
  <version>0.0.5</version>
</dependency>

2. Run via command line

$ mvn install

Usage

import io.github.peppys.badger.Badge;

Badge badge = Badge.builder()
        .setLabelText("build")
        .setLabelColor("black")
        .setMessageText("passing")
        .setMessageColor("green")
        .build();

String svg = badge.render()

service

Local setup

1. Run API

$ docker-compose up api

2. Render via endpoint

$ curl -X GET "http://localhost:8080/badge.svg?label_text=build&label_color=black&message_text=passing&message_color=green"

Demo

Demo URL: https://badger-oxm27jqbha-uc.a.run.app/badge.svg?label_text=demo&label_color=black&message_text=hello%20world&message_color=green

Demo Badge: