Files
dynamic-badges-action/action.yml
Rúnar Berg a2d3829b14 Add save svg-badge directly to gist
This adds the posibility of saving an SVG badge generated by the same
shields.io dirictly to the gist. Instead of prepering a JSON file to
be sent to their service, we use their library directly, which outputs
an SVG file that we can save to the user’s gist.

Filenames ending in `.svg` will use this library automatically.

Additionally there is a major refactoring where the older `node:http`
library has been swapped out for `fetch`.

Also swap from node 16 to node 20

fixes #24
2023-10-05 08:29:45 -07:00

77 lines
2.6 KiB
YAML

name: 'Dynamic Badges'
description: 'Create badges via shields.io/endpoint for your README.md which may change with every commit.'
branding:
icon: 'tag'
color: 'green'
inputs:
auth:
description: 'Your secret with the gist scope'
required: true
gistID:
description: 'The ID of the gist to use'
required: true
filename:
description: 'The *.json or *.svg filename of the badge data'
required: true
label:
description: 'The left text of the badge'
required: true
message:
description: 'The right text of the badge'
required: true
forceUpdate:
description: 'If set to true, the gist will be updated even if the content did not change'
default: 'false'
required: false
labelColor:
description: 'The left color of the badge'
required: false
color:
description: 'The right color of the badge'
required: false
isError:
description: 'The color will be red and cannot be overridden'
required: false
namedLogo:
description: 'A logo name from simpleicons.org'
required: false
logoSvg:
description: 'An svg-string to be used as logo'
required: false
logoColor:
description: 'The color for the logo'
required: false
logoWidth:
description: 'The space allocated for the logo'
required: false
logoPosition:
description: 'The position of the logo'
required: false
style:
description: 'The style like "flat" or "social"'
required: false
cacheSeconds:
description: 'The cache lifetime in seconds (must be greater than 300)'
required: false
valColorRange:
description: 'A numerical value used to define the message color. Usually this should be between maxColorRange and minColorRange. This is required if you want to use the color range feature.'
required: false
maxColorRange:
description: 'If valColorRange assumes this value, the badge will be green. This is required if you want to use the color range feature.'
required: false
minColorRange:
description: 'If valColorRange assumes this value, the badge will be red. This is required if you want to use the color range feature.'
required: false
invertColorRange:
description: 'If the range should be inverted, causing a smaller value to have green color. Defaults to false.'
required: false
colorRangeSaturation:
description: 'Saturation used by the color range feature. Defaults to 100.'
required: false
colorRangeLightness:
description: 'Lightness used by the color range feature. Defaults to 40.'
required: false
runs:
using: 'node20'
main: 'index.js'