mirror of
https://github.com/rlespinasse/slugify-value.git
synced 2026-06-11 09:13:00 +00:00
1300b1ecaf
To be compliant with Hostname syntax, we need to remove underscores from the slug value. Since the hostname is part of the URL, we update the SLUG_URL values instead of creating a new SLUG_HOSTNAME (for example).
120 lines
2.5 KiB
Markdown
120 lines
2.5 KiB
Markdown
# Slugify
|
|
|
|
> Github Action to slugify a value
|
|
|
|
Produce some `slug`-ed environment variables based on the input one.
|
|
|
|
- `<env name>_SLUG`
|
|
|
|
- put the variable content in lower case
|
|
- replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
|
|
- remove leading and trailing `-` character
|
|
- limit the string size to 63 characters
|
|
|
|
- `<env name>_SLUG_CS`
|
|
|
|
- like `<env name>_SLUG` but the content is not put in lower case
|
|
|
|
- `<env name>_SLUG_URL` (or `<env name>_SLUG_URL_CS`)
|
|
|
|
- like `<env name>_SLUG` (or `<env name>_SLUG_CS`) with the `.`, and `_` characters also replaced by `-`
|
|
|
|
## Usage
|
|
|
|
- Slugify a value and store it using a key
|
|
|
|
```yaml
|
|
- uses: rlespinasse/slugify-value@v1.x
|
|
with:
|
|
key: KEY_NAME
|
|
value: value_to_slugify
|
|
```
|
|
|
|
Will make available
|
|
|
|
- `KEY_NAME`
|
|
- `KEY_NAME_SLUG`
|
|
- `KEY_NAME_SLUG_CS`
|
|
- `KEY_NAME_SLUG_URL`
|
|
- `KEY_NAME_SLUG_URL_CS`
|
|
|
|
- Slugify the value of an environment variable
|
|
|
|
```yaml
|
|
- uses: rlespinasse/slugify-value@v1.x
|
|
with:
|
|
key: EXISTING_ENV_VAR
|
|
```
|
|
|
|
Will make available
|
|
|
|
- `EXISTING_ENV_VAR_SLUG`
|
|
- `EXISTING_ENV_VAR_SLUG_CS`
|
|
- `EXISTING_ENV_VAR_SLUG_URL`
|
|
- `EXISTING_ENV_VAR_SLUG_URL_CS`
|
|
|
|
- Slugify the value of an environment variable with prefix
|
|
|
|
```yaml
|
|
- uses: rlespinasse/slugify-value@v1.x
|
|
with:
|
|
key: EXISTING_ENV_VAR
|
|
prefix: CI_
|
|
```
|
|
|
|
Will make available
|
|
|
|
- `CI_EXISTING_ENV_VAR`
|
|
- `CI_EXISTING_ENV_VAR_SLUG`
|
|
- `CI_EXISTING_ENV_VAR_SLUG_CS`
|
|
- `CI_EXISTING_ENV_VAR_SLUG_URL`
|
|
- `CI_EXISTING_ENV_VAR_SLUG_URL_CS`
|
|
|
|
- Slugify a value with a different slug length
|
|
|
|
```yaml
|
|
- uses: rlespinasse/slugify-value@v1.x
|
|
with:
|
|
key: EXISTING_ENV_VAR
|
|
slug-maxlength: 80
|
|
```
|
|
|
|
Will produce SLUG variables with a 80-char length
|
|
|
|
- Slugify a value without length limit
|
|
|
|
```yaml
|
|
- uses: rlespinasse/slugify-value@v1.x
|
|
with:
|
|
key: EXISTING_ENV_VAR
|
|
slug-maxlength: "nolimit"
|
|
```
|
|
|
|
Will produce SLUG variables without limiting the output length
|
|
|
|
## Inputs
|
|
|
|
### `key`
|
|
|
|
Environment variable that will hold the value and serve as prefix to slugified value.
|
|
|
|
This input is _Mandatory_.
|
|
|
|
### `value`
|
|
|
|
The value to slugify. If not set the value will be taken from the `key` input as environment variable.
|
|
|
|
This input is _Optional_.
|
|
|
|
### `prefix`
|
|
|
|
The value will be prepend to each generated variable.
|
|
|
|
This input is _Optional_.
|
|
|
|
### `slug-maxlength`
|
|
|
|
The value is a number or `nolimit` to reflect the length of the slug outputs
|
|
|
|
This input is _Optional_. The default value is `63`.
|