Skip to content
toggle-left

GitHub Action

Shielded.dev Badge Action

v1 Latest version

Shielded.dev Badge Action

toggle-left

Shielded.dev Badge Action

Update a badge on Shielded.dev

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Shielded.dev Badge Action

uses: ShieldedDotDev/shielded-action@v1

Learn more about this action in ShieldedDotDev/shielded-action

Choose a version

shielded-action

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.

Examples

Build Status Build Status
Code Coverage Code Coverage
Code Quality Code Quality
License License
Version Version
Downloads Downloads
Open Issues Open Issues
Open Pull Requests Open Pull Requests
Code Size Code Size
Contributors Contributors
Commit Activity Commit Activity
Release Activity Release Activity

Usage

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'

Inputs

  • 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