GitHub Action
Shielded.dev Badge Action
v1
Latest version
Shielded.dev is a free service that allows you to create custom shields for your projects. This action allows you to update the status of a shield on Shielded.dev from your GitHub Actions workflow.
This action updates a badge on Shielded.dev with the latest status of your project as specified in the action's inputs.
Build Status | |
Code Coverage | |
Code Quality | |
License | |
Version | |
Downloads | |
Open Issues | |
Open Pull Requests | |
Code Size | |
Contributors | |
Commit Activity | |
Release Activity |
name: Update Shield
on:
push:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Update Shielded.dev Badge
uses: shieldeddotdev/shielded-action@v1
with:
shielded-token: ${{ secrets.SHIELDED_TOKEN }}
title: 'Title of the badge'
color: '0011aa'
text: '0 warnings'
- shielded-token (Required) - Your shielded.dev token
- endpoint (Optional) - The endpoint to use. Defaults to
https://api.shielded.dev/
- title (Optional) - The title of the badge - omitting this will leave it as-is
- color (Optional) - The color of the badge - omitting this will leave it as-is
- text (Optional) - The text of the badge - omitting this will leave it as-is