Files
dynamic-badges-action/action.yml

81 lines
2.7 KiB
YAML
Raw Normal View History

2020-08-15 12:11:58 +02:00
name: 'Dynamic Badges'
2022-04-18 20:42:43 +02:00
description: 'Create badges via shields.io/endpoint for your README.md which may change with every commit.'
2020-08-15 12:11:58 +02:00
branding:
icon: 'tag'
color: 'green'
2020-08-15 12:02:21 +02:00
inputs:
2020-08-15 12:11:58 +02:00
auth:
description: 'Your secret with the gist scope'
2020-08-15 12:02:21 +02:00
required: true
2020-08-15 20:46:27 +02:00
gistID:
2020-08-15 12:11:58 +02:00
description: 'The ID of the gist to use'
required: true
2020-08-15 20:46:27 +02:00
filename:
description: 'The *.json or *.svg filename of the badge data'
2020-08-15 12:18:20 +02:00
required: true
2020-08-15 12:11:58 +02:00
label:
description: 'The left text of the badge'
required: true
message:
description: 'The right text of the badge'
required: true
2023-10-07 18:49:27 +02:00
host:
description: 'The base URL of the gist API'
default: 'https://api.github.com/gists/'
required: false
forceUpdate:
description: 'If set to true, the gist will be updated even if the content did not change'
default: 'false'
required: false
2020-08-15 20:46:27 +02:00
labelColor:
2020-08-15 12:11:58 +02:00
description: 'The left color of the badge'
required: false
color:
description: 'The right color of the badge'
required: false
2020-08-15 20:46:27 +02:00
isError:
2020-08-15 14:26:46 +02:00
description: 'The color will be red and cannot be overridden'
2020-08-15 13:03:27 +02:00
required: false
2020-08-15 20:46:27 +02:00
namedLogo:
2020-08-15 14:26:46 +02:00
description: 'A logo name from simpleicons.org'
2020-08-15 13:03:27 +02:00
required: false
2020-08-15 20:46:27 +02:00
logoSvg:
2020-08-15 14:26:46 +02:00
description: 'An svg-string to be used as logo'
2020-08-15 13:03:27 +02:00
required: false
2020-08-15 20:46:27 +02:00
logoColor:
2020-08-15 14:26:46 +02:00
description: 'The color for the logo'
2020-08-15 13:03:27 +02:00
required: false
2020-08-15 20:46:27 +02:00
logoWidth:
2020-08-15 14:26:46 +02:00
description: 'The space allocated for the logo'
2020-08-15 13:03:27 +02:00
required: false
2020-08-15 20:46:27 +02:00
logoPosition:
2020-08-15 14:26:46 +02:00
description: 'The position of the logo'
2020-08-15 13:03:27 +02:00
required: false
style:
2020-08-15 14:26:46 +02:00
description: 'The style like "flat" or "social"'
2020-08-15 13:03:27 +02:00
required: false
2020-08-15 20:46:27 +02:00
cacheSeconds:
2020-08-15 14:26:46 +02:00
description: 'The cache lifetime in seconds (must be greater than 300)'
2020-08-15 13:03:27 +02:00
required: false
valColorRange:
2022-04-18 13:50:35 +02:00
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:
2022-04-18 13:50:35 +02:00
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:
2022-04-18 13:50:35 +02:00
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:
2022-04-18 13:50:35 +02:00
description: 'If the range should be inverted, causing a smaller value to have green color. Defaults to false.'
required: false
colorRangeSaturation:
2022-04-18 13:38:34 +02:00
description: 'Saturation used by the color range feature. Defaults to 100.'
required: false
colorRangeLightness:
2022-04-18 13:38:34 +02:00
description: 'Lightness used by the color range feature. Defaults to 40.'
required: false
2020-08-15 12:02:21 +02:00
runs:
using: 'node20'
2020-08-15 12:02:21 +02:00
main: 'index.js'