badgie

Badgie

Badgie scans the contents of your repository and adds badges based on what it finds.

Do not use this software unless you are an active collaborator on the associated research project.

This project is an output of an ongoing, active research project. It is published without warranty, is subject to change at any time, and has not been certified, tested, assessed, or otherwise assured of safety by any person or organization. Use at your own risk.

Using Badgie

Install Badgie:

python3 -m pip install badgie

Add Badgie tags to your README:

<!-- BADGIE TIME -->
<!-- END BADGIE TIME -->

Run Badgie:

badgie -w README.md

And enjoy magic badges:

<!-- BADGIE TIME -->

[![pipeline status](brettops/containers/verible/badges/main/pipeline.svg)](brettops/containers/verible/-/commits/main)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

<!-- END BADGIE TIME -->

Use as a pre-commit hook

Badgie can be used as a pre-commit hook, so you can get fresh badges on every commit.

Add the following to a .pre-commit-config.yaml file. Note the empty rev tag:

repos:
  - repo: https://gitlab.com/buildgarden/tools/badgie
    rev: ""
    hooks:
      - id: badgie

Run pre-commit autoupdate to pin to the latest version:

pre-commit autoupdate

Run pre-commit directly or install as a hook:

# directly
pre-commit

# as a Git hook
pre-commit install
git commit -m "..."