Overview

Action to create a badge for a github reusable workflow. When using reusable workflows github does not create a workflow badge. This action will create a badge for the workflow and commit the badge to git.

The service badgen.net is used to render the badge.

Simple Usage

Given a workflow (workflow.yml) that executes on push events

# workflow.yml

name: Test workflow badge action

on:
  push:
    branches:
    - '*'
    - '!badges'
        
jobs:
  test:
    name: test workflow badge
    uses: ./.github/workflows/echo.yml

and a reusable workflow (echo.yml)

# echo.yml
name: test echo

on:
  workflow_call:
  
jobs:
  echo:
    name: test echo
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4

    - name: Echo command
      id: echo
      shell: bash
      run: echo "Hello World"

    # Create badge for the preceding step
    - name: create badge
      uses: srfoster65/workflow_badge_action@main
      with:
        label: ${{ github.job}}
        status: ${{ steps.echo.outcome }}

The above example will create a workflow badge, and commit the badge to the badges branch as [working_branch]/echo.svg

To apply to your workflow:

in the main workflow, ensure the workflow does not run when commiting changes to the badges branch

e.g.

on:
  push:
    branches:
    - '*'
    - '!badges'

Then in the reusable workflow, call workflow_badge_action using the name of the job as the label and the outcome of the actual test case as the status.

    - name: create badge
      uses: srfoster65/workflow_badge_action@main
      with:
        label: ${{ github.job}}
        status: ${{ steps.[step id].outcome }}

Input Options

Type

The type of badge to generate:

• workflow (default)
• percentage
• custom

Workflow

A workflow badge expects the status value to be an output from a step outcome. The status value is translated to the value/colour rendered in the badge as follows:

• success: passing - green
• failure: failing - red
• skipped: failing - red
• cancelled: cancelled - grey

Percentage

A percentage badge expects the status to be a numeric value in the range: 0 <= value <= 100 The value is rendered as the badge status, with the colour being set in the range of red, through orange to green depending upon the percentage.

Custom

A custom badge has the parameters passed directly to badgen.net for rendering.

Label

Required parameter.
The text applied to the left hand side of the badge. This value is also used to name the badge.svg file that is committed to git.

Status

Required parameter.
If status is a known output from a workflow outcome, the text and colour of the badge will be set as follows.

Status	Badge Status	Colour
success	passing	green
failure	failing	red
cancelled	cancelled	grey
skipped	skipped	grey

Any other value will be displayed without modification

Colour

Colour can be a hex value or named colour. If a value is supplied it will override default behaviour.
Default behaviour is to use a colour mapping if status is matches a known value, else default to blue.

See here for named colours supported.

Icon

Icon can be a named icon. If a value is supplied it will override default behaviour.
If no icon is specified, a github icon will be applied to the badge. If no icon is required then icon should be specifed with no value when calling the action.

See here for named icons supported.

Badges Branch

Badges_branch can be speciifed to allow committing badges to a named branch.
If no value is supplied, the branch "badges" is used.

Label Colour

Label_colour can be a hex or named colour. If a value is supplied it will override default behaviour.
If no value is supplied, label colour grey is used.

Outputs

The generated badge is committed to badges_branch (Default: badges)

It is saved to: ./[working_branch]/[label].svg

where:

• working_branch: The current git branch
• label: The left hand text of the badge

The badge can be referenced using the following URL:

https://raw.githubusercontent.com/[github account]/[github project]/badges/[branch]/[label].svg

e.g.
Use the following markdown in README.md to render a badge named workflow_passing, on main.

![svg badge](https://raw.githubusercontent.com/srfoster65/workflow_badge_action/badges/main/workflow_passing.svg)

Note

If your workflow run fails with the following error:

Error: Error: Pushing to https://github.com/[REPO]
remote: Permission to [REPO].git denied to github-actions[bot].
fatal: unable to access 'https://github.com/[REPO]/': The requested URL returned error: 403

be sure to have enabled write access for actions under:
Settings -> Actions -> General -> Workflow Settings