Skip to main content

Status build shields for Sloth CI powered by http://shields.io

Project description

Status build badges for Sloth CI apps, powered by http://shields.io.


Installation
------------

.. code-block:: bash

$ pip install sloth-ci.ext.shields_io


Usage
-----

#. Enable the extension in the server config:

.. code-block:: yaml
:caption: sloth.yml for Shields.io

extensions:
shields:
# Use the module sloth_ci.ext.shields_io.
module: shields_io

# Badge label. You can use the ``{app}`` and ``{timestamp}`` placeholders for app name and build timestamp.
# label: "My Sloth CI Status for {app}" # default is ``Sloth CI: {app}``

# Badge status. You can use ``{status}``, ``{app}``, and ``{timestamp}`` placeholders build status, app name, and build timestamp
# status: "{status}" # default is ``{status}, {timestamp}``

# Badge style: ``plastic``, ``flat``, ``flat-square``, or ``social``
# style: social # default is ``flat``

# Badge format: svg, png, jpg, or gif
# format: png # default is svg

# Color map for build statuses
# colors:
# INFO: green # default is ``brightgreen``
# WARNING: yellowgreen # default is ``yellow``
# ERROR: orange # default is ``red``
...

All params are optional.

#. Use the URL http://host:port/app?action=shield to get your badge.

You can customize the badge on the fly by passing ``label``, ``style``, and ``format`` query params:

- http://host:port/app?action=shield&label=Build%20for%20{app}
- http://host:port/app?action=shield&style=social
- http://host:port/app?action=shield&format=png

Project details


Release history Release notifications

This version
History Node

1.0.5

History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sloth_ci.ext.shields_io-1.0.5-py3-none-any.whl (5.4 kB) Copy SHA256 hash SHA256 Wheel 3.5 Mar 17, 2016
sloth-ci.ext.shields_io-1.0.5.tar.gz (2.9 kB) Copy SHA256 hash SHA256 Source None Mar 17, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page