feat: expose slug values as outputs

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

.github/workflows/slugify-value.yaml

@@ -1,5 +1,9 @@
 name: Slugify Value
-on: [push]
+on:
+  push:
+    branches:
+      - v1.x
+  pull_request:
 jobs:
   os-testing:
     strategy:
@@ -13,82 +17,88 @@ jobs:
 
       # Test 1
       - name: Slugify key only
+        id: slugify-key-only
         uses: ./
         with:
-          key: KEY_TEST
+          key: KEY_ONLY
         env:
-          KEY_TEST: Key_Test.values
+          KEY_ONLY: "refs/head/$-Key_Only.test--value-%-+"
       - name: Validate // Slugify key only
         run: |
-          [[ "${{ env.KEY_TEST }}" == "Key_Test.values" ]]
+          [[ "${{ env.KEY_ONLY }}" == "refs/head/$-Key_Only.test--value-%-+" ]]
-          [[ "${{ env.KEY_TEST_SLUG }}" == "key_test.values" ]]
+          [[ "${{ env.KEY_ONLY_SLUG }}" == "key_only.test--value" ]]
-          [[ "${{ env.KEY_TEST_SLUG_CS }}" == "Key_Test.values" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_CS }}" == "Key_Only.test--value" ]]
-          [[ "${{ env.KEY_TEST_SLUG_URL }}" == "key_test-values" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_URL }}" == "key-only-test--value" ]]
-          [[ "${{ env.KEY_TEST_SLUG_URL_CS }}" == "Key_Test-values" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_URL_CS }}" == "Key-Only-test--value" ]]
+          [[ "${{ env.KEY_ONLY }}" == "${{ steps.slugify-key-only.outputs.value }}" ]]
+          [[ "${{ env.KEY_ONLY_SLUG }}" == "${{ steps.slugify-key-only.outputs.slug }}" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_CS }}" == "${{ steps.slugify-key-only.outputs.slug-cs }}" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_URL }}" == "${{ steps.slugify-key-only.outputs.slug-url }}" ]]
+          [[ "${{ env.KEY_ONLY_SLUG_URL_CS }}" == "${{ steps.slugify-key-only.outputs.slug-url-cs }}" ]]
         shell: bash
 
       # Test 2
       - name: Slugify key only with prefix
         uses: ./
         with:
-          key: KEY_TEST
+          key: KEY_ONLY_WITH_PREFIX
           prefix: CI_
         env:
-          KEY_TEST: Key_Test.values
+          KEY_ONLY_WITH_PREFIX: ${{ env.KEY_ONLY }}
       - name: Validate // Slugify key only with prefix
         run: |
-          [[ "${{ env.CI_KEY_TEST }}" == "${{ env.KEY_TEST }}" ]]
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX }}" == "${{ env.KEY_ONLY }}" ]]
-          [[ "${{ env.CI_KEY_TEST_SLUG }}" == "${{ env.KEY_TEST_SLUG }}" ]]
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX_SLUG }}" == "${{ env.KEY_ONLY_SLUG }}" ]]
-          [[ "${{ env.CI_KEY_TEST_SLUG_CS }}" == "${{ env.KEY_TEST_SLUG_CS }}" ]]
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX_SLUG_CS }}" == "${{ env.KEY_ONLY_SLUG_CS }}" ]]
-          [[ "${{ env.CI_KEY_TEST_SLUG_URL }}" == "${{ env.KEY_TEST_SLUG_URL }}" ]]
+          [[ "${{ env.CI_KEY_ONLY_WITH_PREFIX_SLUG_URL }}" == "${{ env.KEY_ONLY_SLUG_URL }}" ]]
-          [[ "${{ env.CI_KEY_TEST_SLUG_URL_CS }}" == "${{ env.KEY_TEST_SLUG_URL_CS }}" ]]
+          [[ "${{ 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_TEST
+          key: KEY_VALUE
-          value: refs/pulls/feat/-----Some----Changes_to.be------
+          value: "Never gonna give you up Never gonna let you down"
       - name: Validate // Slugify key/value
         run: |
-          [[ "${{ env.KEY_VALUE_TEST }}" == "refs/pulls/feat/-----Some----Changes_to.be------" ]]
+          [[ "${{ env.KEY_VALUE }}" == "Never gonna give you up Never gonna let you down" ]]
-          [[ "${{ env.KEY_VALUE_TEST_SLUG }}" == "feat-some-changes_to.be" ]]
+          [[ "${{ env.KEY_VALUE_SLUG }}" == "never-gonna-give-you-up-never-gonna-let-you-down" ]]
-          [[ "${{ env.KEY_VALUE_TEST_SLUG_CS }}" == "feat-Some-Changes_to.be" ]]
+          [[ "${{ env.KEY_VALUE_SLUG_CS }}" == "Never-gonna-give-you-up-Never-gonna-let-you-down" ]]
-          [[ "${{ env.KEY_VALUE_TEST_SLUG_URL }}" == "feat-some-changes_to-be" ]]
+          [[ "${{ env.KEY_VALUE_SLUG_URL }}" == "never-gonna-give-you-up-never-gonna-let-you-down" ]]
-          [[ "${{ env.KEY_VALUE_TEST_SLUG_URL_CS }}" == "feat-Some-Changes_to-be" ]]
+          [[ "${{ 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: KEY_VALUE_TEST
+          key: ANOTHER_MAX_LENGTH
-          value: refs/pulls/feat/-----Some----Changes_to.be------
+          value: "Never gonna give you up Never gonna let you down"
-          slug-maxlength: 12
+          slug-maxlength: 23
       - name: Validate // Slugify with another max length
         run: |
-          [[ "${{ env.KEY_VALUE_TEST }}" == "refs/pulls/feat/-----Some----Changes_to.be------" ]]
+          [[ "${{ env.ANOTHER_MAX_LENGTH }}" == "Never gonna give you up Never gonna let you down" ]]
-          [[ "${{ env.KEY_VALUE_TEST_SLUG }}" == "feat-some-ch" ]]
+          [[ "${{ env.ANOTHER_MAX_LENGTH_SLUG }}" == "never-gonna-give-you-up" ]]
-          [[ "${{ env.KEY_VALUE_TEST_SLUG_CS }}" == "feat-Some-Ch" ]]
+          [[ "${{ env.ANOTHER_MAX_LENGTH_SLUG_CS }}" == "Never-gonna-give-you-up" ]]
-          [[ "${{ env.KEY_VALUE_TEST_SLUG_URL }}" == "feat-some-ch" ]]
+          [[ "${{ env.ANOTHER_MAX_LENGTH_SLUG_URL }}" == "never-gonna-give-you-up" ]]
-          [[ "${{ env.KEY_VALUE_TEST_SLUG_URL_CS }}" == "feat-Some-Ch" ]]
+          [[ "${{ 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: KEY_VALUE_TEST
+          key: NO_MAX_LENGTH
-          value: refs/pulls/feat/-----Some----Changes_to.be-----Some----Changes_to.be-----Some----Changes_to.be-----Some----Changes_to.be------
+          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.KEY_VALUE_TEST }}" == "refs/pulls/feat/-----Some----Changes_to.be-----Some----Changes_to.be-----Some----Changes_to.be-----Some----Changes_to.be------" ]]
+          [[ "${{ 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.KEY_VALUE_TEST_SLUG }}" == "feat-some-changes_to.be-some-changes_to.be-some-changes_to.be-some-changes_to.be" ]]
+          [[ "${{ 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.KEY_VALUE_TEST_SLUG_CS }}" == "feat-Some-Changes_to.be-Some-Changes_to.be-Some-Changes_to.be-Some-Changes_to.be" ]]
+          [[ "${{ 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.KEY_VALUE_TEST_SLUG_URL }}" == "feat-some-changes_to-be-some-changes_to-be-some-changes_to-be-some-changes_to-be" ]]
+          [[ "${{ 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.KEY_VALUE_TEST_SLUG_URL_CS }}" == "feat-Some-Changes_to-be-Some-Changes_to-be-Some-Changes_to-be-Some-Changes_to-be" ]]
+          [[ "${{ 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
@@ -131,6 +141,29 @@ jobs:
           [[ "${{ steps.slugify-with-wrong-max-length.conclusion }}" == "success" ]]
         shell: bash
 
+      # Test 8
+      - name: Slugify key without env publication
+        id: slugify-key-without-env-publication
+        uses: ./
+        with:
+          key: KEY_WITHTOUT_ENV_PUBLICATION
+          publish-env: false
+        env:
+          KEY_WITHTOUT_ENV_PUBLICATION: "Never gonna give you up"
+      - name: Validate // Slugify key without env publication
+        run: |
+          [[ -z "${{ env.KEY_WITHTOUT_ENV_PUBLICATION }}" ]]
+          [[ -z "${{ env.KEY_WITHTOUT_ENV_PUBLICATION_SLUG }}" ]]
+          [[ -z "${{ env.KEY_WITHTOUT_ENV_PUBLICATION_SLUG_CS }}" ]]
+          [[ -z "${{ env.KEY_WITHTOUT_ENV_PUBLICATION_SLUG_URL }}" ]]
+          [[ -z "${{ env.KEY_WITHTOUT_ENV_PUBLICATION_SLUG_URL_CS }}" ]]
+          [[ "${{ steps.slugify-key-without-env-publication.outputs.value }}" == "Never gonna give you up" ]]
+          [[ "${{ steps.slugify-key-without-env-publication.outputs.slug }}" == "never-gonna-give-you-up" ]]
+          [[ "${{ steps.slugify-key-without-env-publication.outputs.slug-cs }}" == "Never-gonna-give-you-up" ]]
+          [[ "${{ steps.slugify-key-without-env-publication.outputs.slug-url }}" == "never-gonna-give-you-up" ]]
+          [[ "${{ steps.slugify-key-without-env-publication.outputs.slug-url-cs }}" == "Never-gonna-give-you-up" ]]
+        shell: bash
+
   release:
     runs-on: ubuntu-latest
     concurrency:

README.md

@@ -17,7 +17,7 @@ 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
 
@@ -81,7 +81,7 @@ Produce some `slug`-ed environment variables based on the input one.
 
   Will produce SLUG variables with a 80-char length
 
-- Slugify a value without 
+- Slugify a value without length limit
 
   ```yaml
   - uses: rlespinasse/slugify-value@v1.x
@@ -114,6 +114,12 @@ This input is _Optional_.
 
 ### `slug-maxlength`
 
-The value is a number or `nolimit` to reflect the length of the slug outputs
+The value is a number or `nolimit` to reflect the length of the slug outputs.
 
 This input is _Optional_. The default value is `63`.
+
+### `publish-env`
+
+In addition of the action output, the slug values are publish as environment variables.
+
+This input is _Optional_. The default value is `true`.

action.yml

@@ -1,6 +1,9 @@
 name: "Slugify Value"
 description: "Github Action to slugify a value"
 author: "Romain Lespinasse"
+branding:
+  icon: "crop"
+  color: "gray-dark"
 inputs:
   key:
     description: "Environment variable that will hold the value and serve as prefix to slugified value"
@@ -16,16 +19,35 @@ inputs:
     description: "Max length of the slugified values"
     default: "63"
     required: true
-branding:
+  publish-env:
-  icon: "crop"
+    description: "Publish slugs as environment variables"
-  color: "gray-dark"
+    default: "true"
+    required: true
+outputs:
+  value:
+    description: "Value"
+    value: ${{ steps.slugify.outputs.value }}
+  slug:
+    description: "Value slug"
+    value: ${{ steps.slugify.outputs.slug }}
+  slug-cs:
+    description: "Value Slug (Case-sensitive)"
+    value: ${{ steps.slugify.outputs.slug-cs }}
+  slug-url:
+    description: "Value Slug URL"
+    value: ${{ steps.slugify.outputs.slug-url }}
+  slug-url-cs:
+    description: "Value Slug URL (Case-sensitive)"
+    value: ${{ steps.slugify.outputs.slug-url-cs }}
 runs:
   using: "composite"
   steps:
-    - run: $GITHUB_ACTION_PATH/slugify.sh
+    - id: slugify
+      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 }}
+        INPUT_PUBLISH_ENV: ${{ inputs.publish-env }}

slugify.sh

@@ -28,12 +28,20 @@ else
 fi
 
 slug() {
-  output=$(sed -E 's#refs/[^\/]*/##;s/[^a-zA-Z0-9._]+/-/g;s/-+/-/g;s/^-*//;s/-*$//' <<<"$1")
+  # 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() {
-  output=$(sed -E 's#refs/[^\/]*/##;s/[^a-zA-Z0-9_]+/-/g;s/-+/-/g;s/^-*//;s/-*$//' <<<"$1")
+  # 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"
 }
 
@@ -45,10 +53,23 @@ reduce() {
   fi
 }
 
-{
+SLUG_VALUE=$(slug "$VALUE")
-  echo "${PREFIX}${KEY}=${CS_VALUE}"
+SLUG_CS_VALUE=$(slug "$CS_VALUE")
-  echo "${PREFIX}${KEY}_SLUG=$(slug "$VALUE")"
+SLUG_URL_VALUE=$(slug_url "$VALUE")
-  echo "${PREFIX}${KEY}_SLUG_CS=$(slug "$CS_VALUE")"
+SLUG_URL_CS_VALUE=$(slug_url "$CS_VALUE")
-  echo "${PREFIX}${KEY}_SLUG_URL=$(slug_url "$VALUE")"
+
-  echo "${PREFIX}${KEY}_SLUG_URL_CS=$(slug_url "$CS_VALUE")"
+echo "::set-output name=value::${CS_VALUE}"
-} >>"$GITHUB_ENV"
+echo "::set-output name=slug::${SLUG_VALUE}"
+echo "::set-output name=slug-cs::${SLUG_CS_VALUE}"
+echo "::set-output name=slug-url::${SLUG_URL_VALUE}"
+echo "::set-output name=slug-url-cs::${SLUG_URL_CS_VALUE}"
+
+if [ "${INPUT_PUBLISH_ENV}" == "true" ]; then
+  {
+    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"
+fi