GITGUD

neiam neiam /icon-studio

public · Issues · Pulls · Labels · Forks · Compare · Actions failure · Badges · Packages

⭐

Log in to mark this repository.

Badges

Status badges for master to embed in a README or anywhere else that takes an image. Every option below is part of the page's address, so you can link to any view of it.

This repository now

Every badge this repository has, drawn in your current theme. GitGud pages show badges this way, so they change with the reader's theme.

Status

Activity

Project

Mark

No coverage yet. See reporting to badges below.

Every theme

Fixed to one theme, for embedding where you know the background. Each card sits on its theme's own background. Select a badge to open its image.

Contrast, split style

Badge text is 11px, so it needs 4.5:1. The status dot is a shape and needs 3:1. Where a theme's usual text color falls short, badges use another, named under the ratio.

Theme label success warning error info muted GG
light Aa 7.36 neutral-content Aa 6.62 base-content Aa 4.98 base-content Aa 4.57 ink-black Aa 6.82 primary-content Aa 12.74 base-content Aa 16.45 accent
dark Aa 9.85 neutral-content Aa 4.93 base-300 Aa 5.52 base-300 Aa 4.57 ink-black Aa 6.82 primary-content Aa 16.80 base-content Aa 5.02 accent
her Aa 8.04 neutral-content Aa 14.88 success-content Aa 17.13 warning-content Aa 10.53 error-content Aa 11.77 info-content Aa 14.47 base-content Aa 14.72 accent
afterdark Aa 9.82 neutral-content Aa 14.88 success-content Aa 17.13 warning-content Aa 10.53 error-content Aa 11.77 info-content Aa 17.38 base-content Aa 16.86 accent
forest Aa 6.70 neutral-content Aa 14.88 success-content Aa 17.13 warning-content Aa 10.53 error-content Aa 11.77 info-content Aa 17.56 base-content Aa 16.76 accent
sky Aa 8.99 neutral-content Aa 14.88 success-content Aa 17.13 warning-content Aa 10.53 error-content Aa 11.77 info-content Aa 17.08 base-content Aa 16.35 accent
clays Aa 6.77 neutral-content Aa 14.88 success-content Aa 17.13 warning-content Aa 10.53 error-content Aa 11.77 info-content Aa 16.87 base-content Aa 16.99 accent
stones Aa 7.34 neutral-content Aa 14.88 success-content Aa 17.13 warning-content Aa 10.53 error-content Aa 11.77 info-content Aa 16.86 base-content Aa 17.09 accent
blueprint Aa 7.06 neutral-content Aa 14.88 success-content Aa 17.13 warning-content Aa 10.53 error-content Aa 11.77 info-content Aa 13.92 base-content Aa 16.10 accent

Embed

Uses the style, corners, scale and GG setting above. auto follows the reader's light or dark setting on any site that shows SVG. A PNG can't, so the HTML snippet offers a dark and a light image instead.

Preview of the selected badge
Markdown 
[![CI status](https://gg.neiam.co/r/neiam/icon-studio/badge/ci/square/gg.svg)](https://gg.neiam.co/r/neiam/icon-studio/actions)
HTML, separate dark and light images 
<a href="https://gg.neiam.co/r/neiam/icon-studio/actions">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://gg.neiam.co/r/neiam/icon-studio/badge/ci/square/gg/dark.svg">
    <img alt="CI status" src="https://gg.neiam.co/r/neiam/icon-studio/badge/ci/square/gg/light.svg">
  </picture>
</a>
reStructuredText 
.. image:: https://gg.neiam.co/r/neiam/icon-studio/badge/ci/square/gg.svg
   :target: https://gg.neiam.co/r/neiam/icon-studio/actions
   :alt: CI status
AsciiDoc 
image:https://gg.neiam.co/r/neiam/icon-studio/badge/ci/square/gg.svg[CI status,link=https://gg.neiam.co/r/neiam/icon-studio/actions]
Image URL 
https://gg.neiam.co/r/neiam/icon-studio/badge/ci/square/gg.svg

Reporting to badges

Two job outputs feed the badges. gitgud-coverage takes a percentage: when the job succeeds, the commit gets a coverage status and the coverage badge shows the newest one on master. gitgud-summary says in a few words what a job found, like 1 no fix from an audit: the workflow's badge shows it in place of warning or failing, and so does the job's check on the commit. 

jobs:
  test:
    runs-on: docker
    outputs:
      gitgud-coverage: ${{ steps.coverage.outputs.percent }}
    steps:
      - uses: actions/checkout@v4
      - run: mix test --cover
      - id: coverage
        run: echo "percent=87.3" >> "$GITHUB_OUTPUT"
  audit:
    runs-on: docker
    outputs:
      gitgud-conclusion: ${{ steps.scan.outputs.conclusion }}
      gitgud-summary: ${{ steps.scan.outputs.summary }}
    steps:
      - uses: actions/checkout@v4
      - id: scan
        run: |
          echo "conclusion=warning" >> "$GITHUB_OUTPUT"
          echo "summary=1 no fix" >> "$GITHUB_OUTPUT"