feat: support prepend text to variable names

.github/FUNDING.yml

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

.github/workflows/slugify-value.yaml

@@ -1,8 +1,15 @@
 name: Slugify testing
 on: [push]
 jobs:
-  slugify:
+  slugify-on-os:
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      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
@@ -14,27 +21,55 @@ 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" ]]
           [[ "${{ env.KEY_TEST_SLUG_CS }}" == "Key_Test.values" ]]
           [[ "${{ env.KEY_TEST_SLUG_URL }}" == "key_test-values" ]]
           [[ "${{ env.KEY_TEST_SLUG_URL_CS }}" == "Key_Test-values" ]]
+        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" ]]
           [[ "${{ env.KEY_VALUE_TEST_SLUG_CS }}" == "feat-Some-Changes_to.be" ]]
           [[ "${{ env.KEY_VALUE_TEST_SLUG_URL }}" == "feat-some-changes_to-be" ]]
           [[ "${{ env.KEY_VALUE_TEST_SLUG_URL_CS }}" == "feat-Some-Changes_to-be" ]]
+        shell: bash
+
+  slugify-release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: slugify-release-${{ github.ref }}
+    needs: slugify-on-os
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
 
       # Release
       - name: Release this GitHub Action

README.md

@@ -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_.

action.yml

@@ -1,4 +1,4 @@
-name: "Slugify"
+name: "Slugify Value"
 description: "Github Action to slugify a value"
 author: "Romain Lespinasse"
 inputs:
@@ -8,14 +8,19 @@ 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"
 runs:
   using: "composite"
   steps:
-    - run: ${{ github.action_path }}/slugify.sh
+    - run: $GITHUB_ACTION_PATH/slugify.sh
       shell: bash
       env:
         INPUT_KEY: ${{ inputs.key }}
         INPUT_VALUE: ${{ inputs.value }}
+        INPUT_PREFIX: ${{ inputs.prefix }}

slugify.sh

@@ -1,25 +1,35 @@
 #!/usr/bin/env bash
 
-KEY=${INPUT_KEY^^}
+if [[ "$OSTYPE" == "darwin"* ]]; then
-CS_VALUE=${INPUT_VALUE:-${!INPUT_KEY}}
+  # On MacOS,
-VALUE=${CS_VALUE,,}
+  # bash don't support substitution, so we use 'tr'
+  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() {
   echo "$1" |
-    sed -r 's#refs/[^\/]*/##;s/[^a-zA-Z0-9._]+/-/g;s/^-*//;s/-*$//' |
+    sed -E 's#refs/[^\/]*/##;s/[^a-zA-Z0-9._]+/-/g;s/-+/-/g;s/^-*//;s/-*$//' |
     cut -c1-63
 }
 
 slug_url() {
   echo "$1" |
-    sed -r 's#refs/[^\/]*/##;s/[^a-zA-Z0-9_]+/-/g;s/^-//;s/-$//' |
+    sed -E 's#refs/[^\/]*/##;s/[^a-zA-Z0-9_]+/-/g;s/-+/-/g;s/^-*//;s/-*$//' |
     cut -c1-63
 }
 
 {
-  echo "${KEY}=${CS_VALUE}"
+  echo "${PREFIX}${KEY}=${CS_VALUE}"
-  echo "${KEY}_SLUG=$(slug "$VALUE")"
+  echo "${PREFIX}${KEY}_SLUG=$(slug "$VALUE")"
-  echo "${KEY}_SLUG_CS=$(slug "$CS_VALUE")"
+  echo "${PREFIX}${KEY}_SLUG_CS=$(slug "$CS_VALUE")"
-  echo "${KEY}_SLUG_URL=$(slug_url "$VALUE")"
+  echo "${PREFIX}${KEY}_SLUG_URL=$(slug_url "$VALUE")"
-  echo "${KEY}_SLUG_URL_CS=$(slug_url "$CS_VALUE")"
+  echo "${PREFIX}${KEY}_SLUG_URL_CS=$(slug_url "$CS_VALUE")"
 } >>"$GITHUB_ENV"