2023-10-15 14:05:42 +02:00
# SPDX-FileCopyrightText: Simon Schneegans <code@simonschneegans.de>
# SPDX-License-Identifier: MIT
name : "Dynamic Badges"
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 :
2023-10-15 14:05:42 +02:00
icon : "tag"
color : "green"
2020-08-15 12:02:21 +02:00
inputs :
2020-08-15 12:11:58 +02:00
auth :
2024-07-31 11:46:19 +12:00
description : "Your secret token"
2020-08-15 12:18:20 +02:00
required : true
2020-08-15 12:11:58 +02:00
label :
2023-10-15 14:05:42 +02:00
description : "The left text of the badge"
2020-08-15 12:11:58 +02:00
required : true
message :
2023-10-15 14:05:42 +02:00
description : "The right text of the badge"
2020-08-15 12:11:58 +02:00
required : true
2023-10-07 18:49:27 +02:00
host :
2024-07-31 11:46:19 +12:00
description : "The base URL of the badgestor API"
default : "https://badges.mydomain.com/"
required : true
2020-08-15 20:46:27 +02:00
labelColor :
2023-10-15 14:05:42 +02:00
description : "The left color of the badge"
2020-08-15 12:11:58 +02:00
required : false
color :
2023-10-15 14:05:42 +02:00
description : "The right color of the badge"
2020-08-15 12:11:58 +02:00
required : false
2020-08-15 20:46:27 +02:00
isError :
2023-10-15 14:05:42 +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 :
2023-10-15 14:05:42 +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 :
2023-10-15 14:05:42 +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 :
2023-10-15 14:05:42 +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 :
2023-10-15 14:05:42 +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 :
2023-10-15 14:05:42 +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 :
2023-10-15 14:05:42 +02:00
description : "The cache lifetime in seconds (must be greater than 300)"
2020-08-15 13:03:27 +02:00
required : false
2022-04-15 23:55:40 -03:00
valColorRange :
2023-10-15 14:05:42 +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."
2022-04-15 23:55:40 -03:00
required : false
2022-04-15 13:11:20 -03:00
maxColorRange :
2023-10-15 14:05:42 +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."
2022-04-15 13:11:20 -03:00
required : false
minColorRange :
2023-10-15 14:05:42 +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."
2022-04-15 23:55:40 -03:00
required : false
invertColorRange :
2023-10-15 14:05:42 +02:00
description : "If the range should be inverted, causing a smaller value to have green color. Defaults to false."
2022-04-15 13:11:20 -03:00
required : false
2022-04-17 11:51:01 -03:00
colorRangeSaturation :
2023-10-15 14:05:42 +02:00
description : "Saturation used by the color range feature. Defaults to 100."
2022-04-17 11:51:01 -03:00
required : false
colorRangeLightness :
2023-10-15 14:05:42 +02:00
description : "Lightness used by the color range feature. Defaults to 40."
2022-04-17 11:51:01 -03:00
required : false
2020-08-15 12:02:21 +02:00
runs :
2023-10-15 14:05:42 +02:00
using : "node20"
main : "index.js"