5 Commits

Author SHA1 Message Date
Romain Lespinasse
e0e1ac60ae feat: support prepend text to variable names 2021-12-08 21:48:30 +01:00
Romain Lespinasse
c12f1d6d88 docs: fix slugify key and value example 2021-12-08 21:05:22 +01:00
rlespinasse
dd418141ff ci: rename main workflow 2021-10-19 22:22:59 +02:00
rlespinasse
971b114f9b docs: add funding file 2021-10-14 10:18:30 +02:00
Romain Lespinasse
94d3accefd docs: fix action reference in examples 2021-10-14 10:02:47 +02:00
5 changed files with 67 additions and 10 deletions

3
.github/FUNDING.yml vendored Normal file
View File

@@ -0,0 +1,3 @@
# These are supported funding model platforms
github: rlespinasse

View File

@@ -7,6 +7,9 @@ jobs:
matrix:
os: [macos-latest, ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
concurrency:
group: slugify-on-os-${{ github.ref }}
cancel-in-progress: true
steps:
- name: Checkout
uses: actions/checkout@v2
@@ -18,7 +21,7 @@ jobs:
key: KEY_TEST
env:
KEY_TEST: Key_Test.values
- name: Test result of key only
- name: Validate // Slugify key only
run: |
[[ "${{ env.KEY_TEST }}" == "Key_Test.values" ]]
[[ "${{ env.KEY_TEST_SLUG }}" == "key_test.values" ]]
@@ -28,12 +31,29 @@ jobs:
shell: bash
# Test 2
- name: Slugify key only with prefix
uses: ./
with:
key: KEY_TEST
prefix: CI_
env:
KEY_TEST: Key_Test.values
- name: Validate // Slugify key only with prefix
run: |
[[ "${{ env.CI_KEY_TEST }}" == "${{ env.KEY_TEST }}" ]]
[[ "${{ env.CI_KEY_TEST_SLUG }}" == "${{ env.KEY_TEST_SLUG }}" ]]
[[ "${{ env.CI_KEY_TEST_SLUG_CS }}" == "${{ env.KEY_TEST_SLUG_CS }}" ]]
[[ "${{ env.CI_KEY_TEST_SLUG_URL }}" == "${{ env.KEY_TEST_SLUG_URL }}" ]]
[[ "${{ env.CI_KEY_TEST_SLUG_URL_CS }}" == "${{ env.KEY_TEST_SLUG_URL_CS }}" ]]
shell: bash
# Test 3
- name: Slugify key/value
uses: ./
with:
key: KEY_VALUE_TEST
value: refs/pulls/feat/-----Some----Changes_to.be------
- name: Test result of key only
- name: Validate // Slugify key/value
run: |
[[ "${{ env.KEY_VALUE_TEST }}" == "refs/pulls/feat/-----Some----Changes_to.be------" ]]
[[ "${{ env.KEY_VALUE_TEST_SLUG }}" == "feat-some-changes_to.be" ]]
@@ -44,6 +64,8 @@ jobs:
slugify-release:
runs-on: ubuntu-latest
concurrency:
group: slugify-release-${{ github.ref }}
needs: slugify-on-os
steps:
- name: Checkout
@@ -52,4 +74,3 @@ jobs:
# Release
- name: Release this GitHub Action
uses: rlespinasse/release-that@v1.x

View File

@@ -24,7 +24,7 @@ Produce some `slug`-ed environment variables based on the input one.
- Slugify a value and store it using a key
```yaml
- uses: rlespinasse/slugify@v1.x
- uses: rlespinasse/slugify-value@v1.x
with:
key: KEY_NAME
value: value_to_slugify
@@ -32,6 +32,7 @@ Produce some `slug`-ed environment variables based on the input one.
Will make available
- `KEY_NAME`
- `KEY_NAME_SLUG`
- `KEY_NAME_SLUG_CS`
- `KEY_NAME_SLUG_URL`
@@ -40,7 +41,7 @@ Produce some `slug`-ed environment variables based on the input one.
- Slugify the value of an environment variable
```yaml
- uses: rlespinasse/slugify@v1.x
- uses: rlespinasse/slugify-value@v1.x
with:
key: EXISTING_ENV_VAR
```
@@ -51,3 +52,28 @@ Produce some `slug`-ed environment variables based on the input one.
- `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`
## Inputs
### `prefix`
The value will be prepend to each generated variable.
This input is _Optional_.

View File

@@ -8,6 +8,10 @@ inputs:
value:
description: "Value to slugify"
required: false
prefix:
description: "Value to prepend to each generated variable"
default: ""
required: false
branding:
icon: "crop"
color: "gray-dark"
@@ -19,3 +23,4 @@ runs:
env:
INPUT_KEY: ${{ inputs.key }}
INPUT_VALUE: ${{ inputs.value }}
INPUT_PREFIX: ${{ inputs.prefix }}

View File

@@ -6,10 +6,12 @@ if [[ "$OSTYPE" == "darwin"* ]]; then
KEY=$(echo "$INPUT_KEY" | tr '[:lower:]' '[:upper:]')
CS_VALUE=${INPUT_VALUE:-${!INPUT_KEY}}
VALUE=$(echo "$CS_VALUE" | tr '[:upper:]' '[:lower:]')
PREFIX=$(echo "$INPUT_PREFIX" | tr '[:lower:]' '[:upper:]')
else
KEY=${INPUT_KEY^^}
CS_VALUE=${INPUT_VALUE:-${!INPUT_KEY}}
VALUE=${CS_VALUE,,}
PREFIX=${INPUT_PREFIX^^}
fi
slug() {
@@ -25,9 +27,9 @@ slug_url() {
}
{
echo "${KEY}=${CS_VALUE}"
echo "${KEY}_SLUG=$(slug "$VALUE")"
echo "${KEY}_SLUG_CS=$(slug "$CS_VALUE")"
echo "${KEY}_SLUG_URL=$(slug_url "$VALUE")"
echo "${KEY}_SLUG_URL_CS=$(slug_url "$CS_VALUE")"
echo "${PREFIX}${KEY}=${CS_VALUE}"
echo "${PREFIX}${KEY}_SLUG=$(slug "$VALUE")"
echo "${PREFIX}${KEY}_SLUG_CS=$(slug "$CS_VALUE")"
echo "${PREFIX}${KEY}_SLUG_URL=$(slug_url "$VALUE")"
echo "${PREFIX}${KEY}_SLUG_URL_CS=$(slug_url "$CS_VALUE")"
} >>"$GITHUB_ENV"