Home

Awesome

Slugify

[!NOTE] A GitHub Action that transforms input strings into URL-friendly slugs

This action creates standardized slug versions of your input variables, offering multiple formatting options:

Output Formats

Each output variable maintains consistent formatting rules while serving different use cases, from basic slugification to URL-ready strings.

Usage

Inputs

InputDescriptionMandatoryDefault
keyEnvironment variable that will hold the value and serve as prefix to slugified valueYes
valueThe value to slugify. If not set the value will be taken from the key input as environment variableNo
prefixThe value will be prepend to each generated variableNo
slug-maxlengthThe value is a number or nolimit to reflect the length of the slug outputsNo63
publish-envIn addition of the action output, the slug values are publish as environment variablesNotrue

Outputs

OutputDescription
valueThe value to be slugify
slugValue Slug
slug-csValue Slug (Case-sensitive)
slug-urlValue Slug URL
slug-url-csValue Slug URL (Case-sensitive)