Add all the badges with Badgie!
The original project can be found here: https://gitlab.com/brettops/tools/badgie/
Install Badgie:
pip install badgie
Add Badgie tags to your README.md:
<!-- BADGIE TIME -->
<!-- END BADGIE TIME -->
Add Badgie tags to your README.rst:
.. <!-- 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 -->
Badgie can be used as a pre-commit hook, so you can get fresh badges on every commit.
Add the following to your .pre-commit-config.yaml
file.
repos:
- repo: https://github.com/CoolCat467/badgie
rev: v0.9.5
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 "..."
Badgie makes decisions on the assumption that you do sensible things with your repository structure. It does not try to work around bad practices. Pull requests that encourage this will be rejected.