actions-marketplace-validations/OGImage

Dynamically generate Open Graph images (OG:Image). This is useful for giving your links more context on Twitter and more.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
template-pathThe path to the html or markdown to use as a templateno
hashtableA hashtable of key/value pairs to replace in the template. Use a FileName key (without an extension) to specify the filename to use for the image, otherwise, it'll be saved with a temporary name.no@{ "FileName" = "blog-thumbnail" "--TITLE--" = "Sample Title" "--AUTHOR--" = "This too" "--SYNOPSIS--" = "Sample body" "--FOOTER--" = "Footer sample" }
hashtable-filepathIf you'd prefer to use an external PowerShell file to create your images instead of a hardcoded hashtable in YAML, you can use this to specify the filepath to use. This file should only contain a hashtable and start with @{no
output-pathThe output path where the generated images will be saved. This will generally be your website's repository. By default, however, it'll save all output to /tmp/pics.no/tmp/pics
stylesheetA comma-separated list of paths to any CSS files you'll be using. Can include file paths and even web addresses.no
no-artifactBy default, the markdown, html and png files are saved as an artifact. Set to true to skip the upload.nofalse
no-optimizeDon't optimize the png (greatly decreases size but takes a bit).nofalse

no outputs