fix: remove dashes group substitution

Co-authored-by: Gaetan BOGAERT <gbogaert62@gmail.com>

.github/FUNDING.yml

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

.github/workflows/slugify-value.yaml

@@ -0,0 +1,150 @@
+name: Slugify Value
+on:
+  push:
+    branches:
+      - v1.x
+  pull_request:
+jobs:
+  os-testing:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      # Test 1
+      - name: Slugify key only
+        uses: ./
+        with:
+          key: KEY_ONLY
+        env:
+          KEY_ONLY: "refs/head/$-Key_Only.test--value-%-+"
+      - name: Validate // Slugify key only
+        run: |
+          [[ "${{ env.KEY_ONLY }}" == "refs/head/$-Key_Only.test--value-%-+" ]]
+          [[ "${{ env.KEY_ONLY_SLUG }}" == "key_only.test--value" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_CS }}" == "Key_Only.test--value" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_URL }}" == "key-only-test--value" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_URL_CS }}" == "Key-Only-test--value" ]]
+        shell: bash
+
+      # Test 2
+      - name: Slugify key only with prefix
+        uses: ./
+        with:
+          key: KEY_ONLY_WITH_PREFIX
+          prefix: CI_
+        env:
+          KEY_ONLY_WITH_PREFIX: ${{ env.KEY_ONLY }}
+      - name: Validate // Slugify key only with prefix
+        run: |
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX }}" == "${{ env.KEY_ONLY }}" ]]
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX_SLUG }}" == "${{ env.KEY_ONLY_SLUG }}" ]]
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX_SLUG_CS }}" == "${{ env.KEY_ONLY_SLUG_CS }}" ]]
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX_SLUG_URL }}" == "${{ env.KEY_ONLY_SLUG_URL }}" ]]
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX_SLUG_URL_CS }}" == "${{ env.KEY_ONLY_SLUG_URL_CS }}" ]]
+        shell: bash
+
+      # Test 3
+      - name: Slugify key/value
+        uses: ./
+        with:
+          key: KEY_VALUE
+          value: "Never gonna give you up Never gonna let you down"
+      - name: Validate // Slugify key/value
+        run: |
+          [[ "${{ env.KEY_VALUE }}" == "Never gonna give you up Never gonna let you down" ]]
+          [[ "${{ env.KEY_VALUE_SLUG }}" == "never-gonna-give-you-up-never-gonna-let-you-down" ]]
+          [[ "${{ env.KEY_VALUE_SLUG_CS }}" == "Never-gonna-give-you-up-Never-gonna-let-you-down" ]]
+          [[ "${{ env.KEY_VALUE_SLUG_URL }}" == "never-gonna-give-you-up-never-gonna-let-you-down" ]]
+          [[ "${{ env.KEY_VALUE_SLUG_URL_CS }}" == "Never-gonna-give-you-up-Never-gonna-let-you-down" ]]
+        shell: bash
+
+      # Test 4
+      - name: Slugify with another max length
+        uses: ./
+        with:
+          key: ANOTHER_MAX_LENGTH
+          value: "Never gonna give you up Never gonna let you down"
+          slug-maxlength: 23
+      - name: Validate // Slugify with another max length
+        run: |
+          [[ "${{ env.ANOTHER_MAX_LENGTH }}" == "Never gonna give you up Never gonna let you down" ]]
+          [[ "${{ env.ANOTHER_MAX_LENGTH_SLUG }}" == "never-gonna-give-you-up" ]]
+          [[ "${{ env.ANOTHER_MAX_LENGTH_SLUG_CS }}" == "Never-gonna-give-you-up" ]]
+          [[ "${{ env.ANOTHER_MAX_LENGTH_SLUG_URL }}" == "never-gonna-give-you-up" ]]
+          [[ "${{ env.ANOTHER_MAX_LENGTH_SLUG_URL_CS }}" == "Never-gonna-give-you-up" ]]
+        shell: bash
+
+      # Test 5
+      - name: Slugify with no limit on max length
+        uses: ./
+        with:
+          key: NO_MAX_LENGTH
+          value: "Never gonna give you up Never gonna let you down Never gonna run around and desert you Never gonna make you cry Never gonna say goodbye Never gonna tell a lie and hurt you"
+          slug-maxlength: "nolimit"
+      - name: Validate // Slugify with no limit on max length
+        run: |
+          [[ "${{ env.NO_MAX_LENGTH }}" == "Never gonna give you up Never gonna let you down Never gonna run around and desert you Never gonna make you cry Never gonna say goodbye Never gonna tell a lie and hurt you" ]]
+          [[ "${{ env.NO_MAX_LENGTH_SLUG }}" == "never-gonna-give-you-up-never-gonna-let-you-down-never-gonna-run-around-and-desert-you-never-gonna-make-you-cry-never-gonna-say-goodbye-never-gonna-tell-a-lie-and-hurt-you" ]]
+          [[ "${{ env.NO_MAX_LENGTH_SLUG_CS }}" == "Never-gonna-give-you-up-Never-gonna-let-you-down-Never-gonna-run-around-and-desert-you-Never-gonna-make-you-cry-Never-gonna-say-goodbye-Never-gonna-tell-a-lie-and-hurt-you" ]]
+          [[ "${{ env.NO_MAX_LENGTH_SLUG_URL }}" == "never-gonna-give-you-up-never-gonna-let-you-down-never-gonna-run-around-and-desert-you-never-gonna-make-you-cry-never-gonna-say-goodbye-never-gonna-tell-a-lie-and-hurt-you" ]]
+          [[ "${{ env.NO_MAX_LENGTH_SLUG_URL_CS }}" == "Never-gonna-give-you-up-Never-gonna-let-you-down-Never-gonna-run-around-and-desert-you-Never-gonna-make-you-cry-Never-gonna-say-goodbye-Never-gonna-tell-a-lie-and-hurt-you" ]]
+        shell: bash
+
+      # Test 6
+      - name: Slugify with empty max length
+        id: slugify-with-empty-max-length
+        uses: ./
+        with:
+          key: EMPTY_MAXLENGTH
+          value: some_value
+          slug-maxlength: ""
+        continue-on-error: true
+      - name: Validate // Slugify with empty max length
+        run: |
+          [[ -z "${{ env.EMPTY_MAXLENGTH }}" ]]
+          [[ -z "${{ env.EMPTY_MAXLENGTH_SLUG }}" ]]
+          [[ -z "${{ env.EMPTY_MAXLENGTH_SLUG_CS }}" ]]
+          [[ -z "${{ env.EMPTY_MAXLENGTH_SLUG_URL }}" ]]
+          [[ -z "${{ env.EMPTY_MAXLENGTH_SLUG_URL_CS }}" ]]
+          [[ "${{ steps.slugify-with-empty-max-length.outcome }}" == "failure" ]]
+          [[ "${{ steps.slugify-with-empty-max-length.conclusion }}" == "success" ]]
+        shell: bash
+
+      # Test 7
+      - name: Slugify with wrong max length
+        id: slugify-with-wrong-max-length
+        uses: ./
+        with:
+          key: WRONG_MAXLENGTH
+          value: some_value
+          slug-maxlength: "wrong"
+        continue-on-error: true
+      - name: Validate // Slugify with wrong max length
+        run: |
+          [[ -z "${{ env.WRONG_MAXLENGTH }}" ]]
+          [[ -z "${{ env.WRONG_MAXLENGTH_SLUG }}" ]]
+          [[ -z "${{ env.WRONG_MAXLENGTH_SLUG_CS }}" ]]
+          [[ -z "${{ env.WRONG_MAXLENGTH_SLUG_URL }}" ]]
+          [[ -z "${{ env.WRONG_MAXLENGTH_SLUG_URL_CS }}" ]]
+          [[ "${{ steps.slugify-with-wrong-max-length.outcome }}" == "failure" ]]
+          [[ "${{ steps.slugify-with-wrong-max-length.conclusion }}" == "success" ]]
+        shell: bash
+
+  release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: release-${{ github.ref }}
+    needs:
+      - os-testing
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      # Release
+      - name: Release this GitHub Action
+        uses: rlespinasse/release-that@v1

.github/workflows/slugify.yaml

@@ -1,41 +0,0 @@
-name: Slugify testing
-on: [push]
-jobs:
-  slugify:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      # Test 1
-      - name: Slugify key only
-        uses: ./
-        with:
-          key: KEY_TEST
-        env:
-          KEY_TEST: Key_Test.values
-      - name: Test result of 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" ]]
-
-      # Test 2
-      - name: Slugify key/value
-        uses: ./
-        with:
-          key: KEY_VALUE_TEST
-          value: refs/pulls/feat/-----Some----Changes_to.be------
-      - name: Test result of key only
-        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" ]]
-
-      # Release
-      - name: Release this GitHub Action
-        uses: rlespinasse/release-that@v1.x

README.md

@@ -17,14 +17,14 @@ Produce some `slug`-ed environment variables based on the input one.
 
 - `<env name>_SLUG_URL` (or `<env name>_SLUG_URL_CS`)
 
-  - like `<env name>_SLUG` (or `<env name>_SLUG_CS`) with the `.` character also replaced by `-`
+  - 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@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,68 @@ 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`
+
+- 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`.

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,24 @@ inputs:
   value:
     description: "Value to slugify"
     required: false
+  prefix:
+    description: "Value to prepend to each generated variable"
+    default: ""
+    required: false
+  slug-maxlength:
+    description: "Max length of the slugified values"
+    default: "63"
+    required: true
 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 }}
+        INPUT_SLUG_MAXLENGTH: ${{ inputs.slug-maxlength }}

slugify.sh

@@ -1,25 +1,62 @@
 #!/usr/bin/env bash
 
-KEY=${INPUT_KEY^^}
-CS_VALUE=${INPUT_VALUE:-${!INPUT_KEY}}
-VALUE=${CS_VALUE,,}
+if [[ "$OSTYPE" == "darwin"* ]]; then
+  # On MacOS,
+  # 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
+
+MAX_LENGTH=""
+if [ -z "${INPUT_SLUG_MAXLENGTH}" ]; then
+  echo "::error ::slug-maxlength cannot be empty"
+  exit 1
+elif [ "${INPUT_SLUG_MAXLENGTH}" -eq "${INPUT_SLUG_MAXLENGTH}" ] 2>/dev/null; then
+  MAX_LENGTH="${INPUT_SLUG_MAXLENGTH}"
+elif [ "${INPUT_SLUG_MAXLENGTH}" == "nolimit" ]; then
+  MAX_LENGTH="${INPUT_SLUG_MAXLENGTH}"
+else
+  echo "::error ::slug-maxlength must be a number or equals to 'nolimit'"
+  exit 1
+fi
 
 slug() {
-  echo "$1" |
-    sed -r 's#refs/[^\/]*/##;s/[^a-zA-Z0-9._]+/-/g;s/^-*//;s/-*$//' |
-    cut -c1-63
+  # 1st : Remove refs prefix
+  # 2d : Replace unwanted characters
+  # 3d : Remove leading dashes
+  # 4d : Remove trailing dashes
+  output=$(sed -E 's#refs/[^\/]*/##;s/[^a-zA-Z0-9._-]+/-/g;s/^-*//;s/-*$//' <<<"$1")
+  reduce "$output"
 }
 
 slug_url() {
-  echo "$1" |
-    sed -r 's#refs/[^\/]*/##;s/[^a-zA-Z0-9_]+/-/g;s/^-//;s/-$//' |
-    cut -c1-63
+  # 1st : Remove refs prefix
+  # 2d : Replace unwanted characters
+  # 3d : Remove leading dashes
+  # 4d : Remove trailing dashes
+  output=$(sed -E 's#refs/[^\/]*/##;s/[^a-zA-Z0-9-]+/-/g;s/^-*//;s/-*$//' <<<"$1")
+  reduce "$output"
+}
+
+reduce() {
+  if [ "${MAX_LENGTH}" == "nolimit" ]; then
+    echo "$1"
+  else
+    cut -c1-"${MAX_LENGTH}" <<<"$1"
+  fi
 }
 
 {
-  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"