feat: bump actions/checkout from 5 to 6 (#172)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Romain Lespinasse <romain.lespinasse@gmail.com>

.dependabot/config.xml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @rlespinasse

.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/.github/'
+    schedule:
+      interval: 'weekly'
+    groups:
+      dependencies:
+        patterns:
+          - '*'
+    labels: []
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    commit-message:
+      prefix: 'feat: '
+    schedule:
+      interval: 'weekly'
+    groups:
+      dependencies:
+        patterns:
+          - 'rlespinasse/slugify-value'
+          - 'rlespinasse/shortify-git-revision'
+    labels: []

.github/workflows/check-variables.yml

@@ -0,0 +1,139 @@
+---
+name: Compare GitHub Variables
+
+on:
+  workflow_dispatch: # Manual trigger
+  schedule:
+    - cron: "0 0 * * 1" # Weekly on Monday at midnight
+  pull_request:
+
+permissions: read-all
+
+jobs:
+  compare-variables:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Load environment variables for testing
+        uses: rlespinasse/github-slug-action@v5
+        with:
+          prefix: TEST_
+
+      - name: Compare GitHub variables
+        id: compare
+        run: |
+          # Initialize arrays to store results
+          MISMATCHED_VARS=()
+          TEST_VALUES=()
+          ACTUAL_VALUES=()
+
+          # Get all environment variables
+          ALL_ENV=$(env)
+
+          # Extract TEST_GITHUB variables
+          TEST_VARS=$(echo "$ALL_ENV" | grep "^TEST_GITHUB_" | cut -d= -f1)
+
+          # Check for mismatches
+          for TEST_VAR in $TEST_VARS; do
+          # Get the corresponding GITHUB variable name
+          GITHUB_VAR=${TEST_VAR/TEST_GITHUB_/GITHUB_}
+
+          # Get the values
+          TEST_VALUE="${!TEST_VAR}"
+
+          # Check if the GITHUB variable exists
+          if [[ -n "${!GITHUB_VAR+x}" ]]; then
+            GITHUB_VALUE="${!GITHUB_VAR}"
+
+            # Compare values
+            if [[ "$TEST_VALUE" != "$GITHUB_VALUE" ]]; then
+              MISMATCHED_VARS+=("$TEST_VAR vs $GITHUB_VAR")
+              TEST_VALUES+=("$TEST_VALUE")
+              ACTUAL_VALUES+=("$GITHUB_VALUE")
+              echo "Mismatch found: $TEST_VAR=$TEST_VALUE, $GITHUB_VAR=$GITHUB_VALUE"
+            else
+              echo "Match: $TEST_VAR=$TEST_VALUE, $GITHUB_VAR=$GITHUB_VALUE"
+            fi
+          else
+            echo "Skipping $TEST_VAR as $GITHUB_VAR does not exist"
+          fi
+          done
+
+          # Set output for next steps
+          if [[ ${#MISMATCHED_VARS[@]} -gt 0 ]]; then
+          echo "has_mismatches=true" >>"$GITHUB_OUTPUT"
+
+          # Create a JSON array of mismatched variables for the issue
+          MISMATCHED_JSON=$(printf '"%s",' "${MISMATCHED_VARS[@]}" | sed 's/,$//')
+          MISMATCHED_JSON="[$MISMATCHED_JSON]"
+          echo "mismatched_vars=$MISMATCHED_JSON" >>"$GITHUB_OUTPUT"
+
+          # Create a JSON array of test values
+          TEST_JSON=$(printf '"%s",' "${TEST_VALUES[@]}" | sed 's/,$//')
+          TEST_JSON="[$TEST_JSON]"
+          echo "test_values=$TEST_JSON" >>"$GITHUB_OUTPUT"
+
+          # Create a JSON array of actual values
+          ACTUAL_JSON=$(printf '"%s",' "${ACTUAL_VALUES[@]}" | sed 's/,$//')
+          ACTUAL_JSON="[$ACTUAL_JSON]"
+          echo "actual_values=$ACTUAL_JSON" >>"$GITHUB_OUTPUT"
+
+          # Create summary table
+          {
+            echo "## GitHub Variable Mismatches";
+            echo "| Variable Pair | TEST Value | GITHUB Value |";
+            echo "| ------------- | ---------- | ------------ |";
+          } >>"$GITHUB_STEP_SUMMARY"
+
+          for i in "${!MISMATCHED_VARS[@]}"; do
+            echo "| ${MISMATCHED_VARS[$i]} | ${TEST_VALUES[$i]} | ${ACTUAL_VALUES[$i]} |" >>"$GITHUB_STEP_SUMMARY"
+          done
+          else
+          echo "has_mismatches=false" >>"$GITHUB_OUTPUT"
+          echo "## All GitHub Variables Match" >>"$GITHUB_STEP_SUMMARY"
+          echo "All action GITHUB_ variables match their official GITHUB_ counterparts." >>"$GITHUB_STEP_SUMMARY"
+          fi
+        shell: bash
+
+      - name: Create issue for mismatches
+        if: steps.compare.outputs.has_mismatches == 'true' && github.event_name != 'pull_request'
+        uses: actions/github-script@v8
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const mismatchedVars = JSON.parse('${{ steps.compare.outputs.mismatched_vars }}');
+            const testValues = JSON.parse('${{ steps.compare.outputs.test_values }}');
+            const actualValues = JSON.parse('${{ steps.compare.outputs.actual_values }}');
+
+            // Create table for issue body
+            let tableBody = '| Variable Pair | TEST Value | GITHUB Value |\n';
+            tableBody += '| ------------- | ---------- | ------------ |\n';
+
+            for (let i = 0; i < mismatchedVars.length; i++) {
+              tableBody += `| ${mismatchedVars[i]} | ${testValues[i]} | ${actualValues[i]} |\n`;
+            }
+
+            // Create the issue
+            const issueTitle = `GitHub Variable Mismatches Detected - ${new Date().toISOString().split('T')[0]}`;
+            const issueBody = `## GitHub Variable Mismatches Detected\n\nThe following mismatches were found between the action **GITHUB_** variables and their official **GITHUB_** counterparts:\n\n${tableBody}\n\nPlease review these discrepancies and update the test variables as needed.`;
+
+            await github.rest.issues.create({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              title: issueTitle,
+              body: issueBody,
+              labels: ['bug']
+            });
+
+            console.log('Issue created for GitHub variable mismatches');
+
+      - name: Fail workflow if mismatches detected
+        if: steps.compare.outputs.has_mismatches == 'true' && github.event_name == 'pull_request'
+        run: |
+          echo "::error::GitHub variable mismatches detected! See the summary for details."
+          exit 1

.github/workflows/linter.yml

@@ -0,0 +1,32 @@
+---
+name: Lint Code Base
+
+on: pull_request
+
+permissions: read-all
+
+jobs:
+  build:
+    name: Lint Code Base
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: read
+      statuses: write
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v6
+        with:
+          # Full git history is needed to get a proper
+          # list of changed files within `super-linter`
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: super-linter/super-linter@v8
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
+          VALIDATE_JSCPD: false
+          VALIDATE_MARKDOWN_PRETTIER: false
+          VALIDATE_YAML_PRETTIER: false
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/v5-tests-and-release.yml

@@ -1,8 +1,9 @@
-name: '[v4] Test and Release'
+name: "[v5] Test and Release"
 on: [push, pull_request]
+permissions: read-all
 jobs:
-  check-v3compatibility:
-    name: 'Check v3 compatibility'
+  check-v4-compatibility:
+    name: "Check v4 compatibility"
     strategy:
       fail-fast: false
       matrix:
@@ -10,16 +11,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
 
-      - name: Load using v4.x with prefix
+      - name: Load this action from HEAD
         uses: ./
+
+      - name: Load using v4
+        uses: rlespinasse/github-slug-action@v4
         with:
           prefix: V4_
-          short-length: 8
-
-      - name: Load using v3.x
-        uses: rlespinasse/github-slug-action@v3.x
 
       - name: Validate // Partial variables
         run: |
@@ -68,13 +68,13 @@ jobs:
           [[ "${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_EVENT_REF_SLUG_URL_CS }}" ]]
         shell: bash
 
-      - name: Validate // Ref Name
+      - name: Validate // Ref Point
         run: |
-          [[ "${{ env.GITHUB_REF_NAME }}" == "${{ env.V4_GITHUB_REF_NAME }}" ]]
-          [[ "${{ env.GITHUB_REF_NAME_SLUG }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG }}" ]]
-          [[ "${{ env.GITHUB_REF_NAME_SLUG_URL }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL }}" ]]
-          [[ "${{ env.GITHUB_REF_NAME_SLUG_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_CS }}" ]]
-          [[ "${{ env.GITHUB_REF_NAME_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL_CS }}" ]]
+          [[ "${{ env.GITHUB_REF_POINT }}" == "${{ env.V4_GITHUB_REF_NAME }}" ]]
+          [[ "${{ env.GITHUB_REF_POINT_SLUG }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG }}" ]]
+          [[ "${{ env.GITHUB_REF_POINT_SLUG_URL }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL }}" ]]
+          [[ "${{ env.GITHUB_REF_POINT_SLUG_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_CS }}" ]]
+          [[ "${{ env.GITHUB_REF_POINT_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL_CS }}" ]]
         shell: bash
 
       - name: Validate // Short SHA variables
@@ -83,10 +83,10 @@ jobs:
           [[ "${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" == "${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" ]]
         shell: bash
 
-  check-v3compatibility-without-checkout:
-    name: 'Check v3 compatibility (without checkout)'
+  check-v4-compatibility-without-checkout:
+    name: "Check v4 compatibility (without checkout)"
     needs:
-      - check-v3compatibility
+      - check-v4-compatibility
     strategy:
       fail-fast: false
       matrix:
@@ -94,19 +94,18 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
         with:
           path: this-action
           ref: ${{ github.ref }}
 
-      - name: Load using v4.x with prefix
+      - name: Load this action from HEAD
         uses: ./this-action
+
+      - name: Load using v4
+        uses: rlespinasse/github-slug-action@v4
         with:
           prefix: V4_
-          short-length: 8
-
-      - name: Load using v3.x
-        uses: rlespinasse/github-slug-action@v3.x
 
       - name: Validate // Short SHA variables
         run: |
@@ -115,7 +114,7 @@ jobs:
         shell: bash
 
   display:
-    name: 'Display produced variables'
+    name: "Display produced variables"
     strategy:
       fail-fast: false
       matrix:
@@ -123,9 +122,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
 
-      - name: Load using v4.x
+      - name: Load this action from HEAD
         uses: ./
 
       - name: Partial variables
@@ -140,48 +139,55 @@ jobs:
           echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG }}"
           echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG }}"
           echo "ref              : ${{ env.GITHUB_REF_SLUG }}"
+          echo "ref name         : ${{ env.GITHUB_REF_NAME_SLUG }}"
           echo "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG }}"
           echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG }}"
           echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG }}"
         shell: bash
+
       - name: Slug variables (Case Sensitive)
         run: |
           echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG_CS }}"
           echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}"
           echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}"
           echo "ref              : ${{ env.GITHUB_REF_SLUG_CS }}"
+          echo "ref name         : ${{ env.GITHUB_REF_NAME_SLUG_CS }}"
           echo "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG_CS }}"
           echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG_CS }}"
           echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG_CS }}"
         shell: bash
+
       - name: Slug URL variables
         run: |
           echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG_URL }}"
           echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}"
           echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}"
           echo "ref              : ${{ env.GITHUB_REF_SLUG_URL }}"
+          echo "ref name         : ${{ env.GITHUB_REF_NAME_SLUG_URL }}"
           echo "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG_URL }}"
           echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG_URL }}"
           echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG_URL }}"
         shell: bash
+
       - name: Slug URL variables (Case Sensitive)
         run: |
           echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}"
           echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}"
           echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}"
           echo "ref              : ${{ env.GITHUB_REF_SLUG_URL_CS }}"
+          echo "ref name         : ${{ env.GITHUB_REF_NAME_SLUG_URL_CS }}"
           echo "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG_URL_CS }}"
           echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}"
           echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}"
         shell: bash
 
-      - name: Ref Name
+      - name: Ref Point
         run: |
-          echo "raw                       : ${{ env.GITHUB_REF_NAME }}"
-          echo "slug                      : ${{ env.GITHUB_REF_NAME_SLUG }}"
-          echo "slug url                  : ${{ env.GITHUB_REF_NAME_SLUG_URL }}"
-          echo "slug (Case Sensitive)     : ${{ env.GITHUB_REF_NAME_SLUG_CS }}"
-          echo "slug url (Case Sensitive) : ${{ env.GITHUB_REF_NAME_SLUG_URL_CS }}"
+          echo "raw                       : ${{ env.GITHUB_REF_POINT }}"
+          echo "slug                      : ${{ env.GITHUB_REF_POINT_SLUG }}"
+          echo "slug url                  : ${{ env.GITHUB_REF_POINT_SLUG_URL }}"
+          echo "slug (Case Sensitive)     : ${{ env.GITHUB_REF_POINT_SLUG_CS }}"
+          echo "slug url (Case Sensitive) : ${{ env.GITHUB_REF_POINT_SLUG_URL_CS }}"
         shell: bash
 
       - name: Short SHA variables
@@ -191,7 +197,7 @@ jobs:
         shell: bash
 
   display-without-checkout:
-    name: 'Display produced variables (without checkout)'
+    name: "Display produced variables (without checkout)"
     needs:
       - display
     strategy:
@@ -201,19 +207,13 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
         with:
           path: this-action
           ref: ${{ github.ref }}
 
-      - name: Load using v4.x with prefix
+      - name: Load this action from HEAD
         uses: ./this-action
-        with:
-          prefix: V4_
-          short-length: 8
-
-      - name: Load using v3.x
-        uses: rlespinasse/github-slug-action@v3.x
 
       - name: Short SHA variables
         run: |
@@ -230,17 +230,17 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
 
       # Test 1
       - name: Using correct short length
         uses: ./
         with:
-          prefix: 'CSL_'
+          prefix: "CSL_"
           short-length: 4
       - name: Using correct length // Validate that all short variables lengths are equals to short-length
         run: |
-          env | grep "CSL_" | grep "_SHORT" | cut -d"=" -f2 | while read -r value; do [ "$(echo "$value" | wc -m)" -le 5 ] ; done
+          env | grep "CSL_" | grep "_SHORT" | cut -d"=" -f2 | while read -r value; do [ "${#value}" -le 5 ] ; done
         shell: bash
 
       # Test 2
@@ -248,12 +248,12 @@ jobs:
         id: using-wrong-short-length
         uses: ./
         with:
-          prefix: 'WSL_'
-          short-length: 'wrong'
+          prefix: "WSL_"
+          short-length: "wrong"
         continue-on-error: true
       - name: Using wrong short length // Validate that the action end with an error
         run: |
-          [[ "$(env | grep "WSL_" | grep "_SHORT" | wc -l)" -eq 0 ]]
+          [[ "$(env | grep "WSL_" | grep "_SHORT" -c)" -eq 0 ]]
           [[ "${{ steps.using-wrong-short-length.outcome }}" == "failure" ]]
           [[ "${{ steps.using-wrong-short-length.conclusion }}" == "success" ]]
         shell: bash
@@ -269,7 +269,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
         with:
           path: this-action
           ref: ${{ github.ref }}
@@ -278,11 +278,11 @@ jobs:
       - name: Using correct short length
         uses: ./this-action
         with:
-          prefix: 'CSL_'
+          prefix: "CSL_"
           short-length: 4
       - name: Using correct length // Validate that all short variables lengths are equals to short-length
         run: |
-          env | grep "CSL_" | grep "_SHORT" | cut -d"=" -f2 | while read -r value; do [ "$(echo "$value" | wc -m)" -le 5 ] ; done
+          env | grep "CSL_" | grep "_SHORT" | cut -d"=" -f2 | while read -r value; do [ "${#value}" -le 5 ] ; done
         shell: bash
 
       # Test 2
@@ -290,11 +290,11 @@ jobs:
         id: using-empty-short-length
         uses: ./this-action
         with:
-          prefix: 'ESL_'
+          prefix: "ESL_"
         continue-on-error: true
       - name: Using empty short length // Validate that the action don't end with an error
         run: |
-          [[ "$(env | grep "ESL_" | grep "_SHORT" | wc -l)" -gt 0 ]]
+          [[ "$(env | grep "ESL_" | grep "_SHORT" -c)" -gt 0 ]]
           [[ "${{ steps.using-empty-short-length.outcome }}" == "success" ]]
           [[ "${{ steps.using-empty-short-length.conclusion }}" == "success" ]]
         shell: bash
@@ -304,12 +304,12 @@ jobs:
         id: using-wrong-short-length
         uses: ./this-action
         with:
-          prefix: 'WSL_'
-          short-length: 'wrong'
+          prefix: "WSL_"
+          short-length: "wrong"
         continue-on-error: true
       - name: Using wrong short length // Validate that the action end with an error
         run: |
-          [[ "$(env | grep "WSL_" | grep "_SHORT" | wc -l)" -eq 0 ]]
+          [[ "$(env | grep "WSL_" | grep "_SHORT" -c)" -eq 0 ]]
           [[ "${{ steps.using-wrong-short-length.outcome }}" == "failure" ]]
           [[ "${{ steps.using-wrong-short-length.conclusion }}" == "success" ]]
         shell: bash
@@ -323,17 +323,17 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
 
       # Test 1
       - name: Using correct slug max length
         uses: ./
         with:
-          prefix: 'CML_'
+          prefix: "CML_"
           slug-maxlength: 1
       - name: Using correct max length // Validate that all slug variables lengths are equals or under the slug-maxlength
         run: |
-          env | grep "CML_" | grep "_SLUG" | cut -d"=" -f2 | while read -r value; do [ "$(echo "$value" | wc -m)" -le 2 ] ; done
+          env | grep "CML_" | grep "_SLUG" | cut -d"=" -f2 | while read -r value; do [ "${#value}" -le 2 ] ; done
         shell: bash
 
       # Test 2
@@ -341,12 +341,12 @@ jobs:
         id: using-wrong-slug-max-length
         uses: ./
         with:
-          prefix: 'WML_'
-          slug-maxlength: 'wrong'
+          prefix: "WML_"
+          slug-maxlength: "wrong"
         continue-on-error: true
       - name: Using wrong slug max length // Validate that the action end with an error
         run: |
-          [[ "$(env | grep "WML_" | grep "_SLUG" | wc -l)" -eq 0 ]]
+          [[ "$(env | grep "WML_" | grep "_SLUG" -c)" -eq 0 ]]
           [[ "${{ steps.using-wrong-slug-max-length.outcome }}" == "failure" ]]
           [[ "${{ steps.using-wrong-slug-max-length.conclusion }}" == "success" ]]
         shell: bash
@@ -356,12 +356,12 @@ jobs:
         id: using-empty-slug-max-length
         uses: ./
         with:
-          prefix: 'EML_'
-          slug-maxlength: ''
+          prefix: "EML_"
+          slug-maxlength: ""
         continue-on-error: true
       - name: Using empty slug max length // Validate that the action end with an error
         run: |
-          [[ "$(env | grep "EML_" | grep "_SLUG" | wc -l)" -eq 0 ]]
+          [[ "$(env | grep "EML_" | grep "_SLUG" -c)" -eq 0 ]]
           [[ "${{ steps.using-empty-slug-max-length.outcome }}" == "failure" ]]
           [[ "${{ steps.using-empty-slug-max-length.conclusion }}" == "success" ]]
         shell: bash
@@ -371,26 +371,32 @@ jobs:
         id: using-nolimit-slug-max-length
         uses: ./
         with:
-          prefix: 'NLML_'
-          slug-maxlength: 'nolimit'
+          prefix: "NLML_"
+          slug-maxlength: "nolimit"
       - name: Using no limit on slug max length // Validate that the action end with an error
         run: |
-          [[ "$(env | grep "NLML_" | grep "_SLUG" | wc -l)" -gt 0 ]]
+          [[ "$(env | grep "NLML_" | grep "_SLUG" -c)" -gt 0 ]]
           [[ "${{ steps.using-nolimit-slug-max-length.outcome }}" == "success" ]]
           [[ "${{ steps.using-nolimit-slug-max-length.conclusion }}" == "success" ]]
         shell: bash
 
   release:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      id-token: write
+      packages: write
     concurrency:
       group: release-${{ github.ref }}-${{ github.event_name }}
     needs:
-      - check-v3compatibility-without-checkout
       - display-without-checkout
       - input-short-length-without-checkout
       - input-slug-maxlength
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
       - name: Release this GitHub Action
         uses: rlespinasse/release-that@v1
+        with:
+          github-token: ${{ secrets.GH_TOKEN }}

CODE_OF_CONDUCT.md

@@ -1,76 +1,133 @@
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a
- professional setting
+  professional setting
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at romain.lespinasse@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement at
+<romain.lespinasse@gmail.com>.
+All complaints will be reviewed and investigated promptly and fairly.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
 
 [homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

README.md

@@ -2,27 +2,6 @@
 
 This GitHub Action will expose the slug/short values of [some GitHub environment variables][default-environment-variables] inside your GitHub workflow.
 
-## Table of Contents
-
-- [GitHub Slug action](#github-slug-action)
-  - [Table of Contents](#table-of-contents)
-  - [Overview](#overview)
-  - [Use this action](#use-this-action)
-    - [Migration from previous versions](#migration-from-previous-versions)
-  - [Available Environment variables](#available-environment-variables)
-    - [Enhanced variables](#enhanced-variables)
-    - [Partial variables](#partial-variables)
-    - [Slug variables](#slug-variables)
-    - [Slug URL variables](#slug-url-variables)
-    - [Short variables](#short-variables)
-  - [Troubleshooting](#troubleshooting)
-    - [The SHORT variables doesn't have the same lengths as before](#the-short-variables-doesnt-have-the-same-lengths-as-before)
-    - [One of the environment variables doesn't work as intended](#one-of-the-environment-variables-doesnt-work-as-intended)
-      - [Known environment variable conflicts](#known-environment-variable-conflicts)
-        - [GITHUB_REF_NAME](#github_ref_name)
-    - [An action could not be found at the URI](#an-action-could-not-be-found-at-the-uri)
-  - [Thanks for talking about us](#thanks-for-talking-about-us)
-
 ## Overview
 
 `SLUG` on a variable will
@@ -33,197 +12,217 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
 - limit the string size to 63 characters
 - remove trailing `-` characters
 
-<details>
-  <summary>Others <b>Slug-ish</b> commands are available</summary>
-  <p>
+### Others Slug-ish variables are available
 
-- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL
+- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in a URL
   - Like `SLUG` but `.`, and `_` are also replaced by `-`
-- `SHORT` on a variable will limit the string size to ~8 characters
+- `SHORT` on a variable will limit the string size to [~8 characters](#with-another-length-for-short-values)
   - Useful for _sha_ value
 - `<KEY>_PART` on a variable will give a part of a variable defined by a key
   - Like `GITHUB_REPOSITORY_OWNER_PART` for the owner part of `GITHUB_REPOSITORY`
-- `<VAR>_CS` on others variables to keep the value case-sensitive
+- `<VAR>_CS` on other variables to keep the value case-sensitive
   - Like `GITHUB_REF_SLUG_CS`
 
-Additional enhanced environment variables can be compute to help you around GitHub environment variables.
-  </p>
-</details>
+## Installation
 
-## Use this action
-
-Add this in your workflow
+Add this step to your workflow
 
 ```yaml
-- name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v4
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
 ```
 
-<details>
-  <summary>Others configurations</summary>
-  <p>
+> [!CAUTION]
+> Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows.
 
-- With a prefix
+## Configuration Options
 
-  ```yaml
-  - name: Inject slug/short variables
-    uses: rlespinasse/github-slug-action@v4
+> [!TIP]
+> Check for more [examples][examples] (OS usage, URL use, ...)
+
+### With a prefix
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
     with:
       prefix: CI_
-  ```
+```
 
-- With another max length for slug values
-
-  ```yaml
-  - name: Inject slug/short variables
-    uses: rlespinasse/github-slug-action@v4
-    with:
-      slug-maxlength: 80 # Use 'nolimit' to remove use of a max length (Default to 63)
-  ```
-
-- With another length for short values
-
-  ```yaml
-  - name: Inject slug/short variables
-    uses: rlespinasse/github-slug-action@v4
-    with:
-      short-length: 7 # By default it's up to git to decide, use 8 to have the v3.x behavior
-  ```
-
-  **Warning**: If you leave it empty, you need to checkout the source first in order to let git decide the size by itself.
-  </p>
-</details>
-
-Check for more [examples][examples] (OS usage, URL use, ...)
-
-**Tip:** Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows.
-
-### Migration from previous versions
-
-The short sha length is not the same as previous version.
-
-- `v4` let git configuration decide of it (but you can override it),
-- `v3` and before, it's always a length of 8 characters.
-
-So to reproduce previous behavior, use
+### With another max length for slug values
 
 ```yaml
-- name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v4
-  with:
-    short-length: 8 # Same as v3 and before
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+    with:
+      slug-maxlength: 80 # Use 'nolimit' to remove use of a max length (Default to 63)
 ```
 
+### With another length for short values
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+    with:
+      short-length: 7 # By default it's up to Git to decide, use 8 to have the v3.x behaviour
+```
+
+The length of a short sha depends on the size of **your repository** and can differ over time :
+
+- set `7` to keep the `small repository` behaviour,
+- set `8` to reproduce `v3` behaviour,
+- set `4` as the minimum length possible.
+
+> [!WARNING]
+> If you leave it empty, you need to checkout the source first to let Git decide the size by itself by using [`git rev-parse`][git-revparse] behaviour.
+>
+> The default is the effective value of the [core.abbrev][git-core-abbrev] configuration variable.
+
 ## Available Environment variables
 
-**Note**: If you don't find what you search for, read more about [available `GitHub` variables](docs/github-variables.md), and propose a [new custom variable][custom-variable].
+> [!TIP]
+> If you don't find what you search for
+>
+> - Read more about [available `GitHub` variables](docs/github-variables.md), and propose a [new custom variable][custom-variable].
+> - Use your own variable with [slugify-value][slugify-value], or [shortify-git-revision][shortify-git-revision] for git reference.
 
 ### Enhanced variables
 
-- `GITHUB_REF_NAME` will contains the reference name (branch or tag)
+- `GITHUB_REF_POINT` will contain the reference name (branch or tag)
   - based on `GITHUB_HEAD_REF` in a [`pull-request*`][webhooks-and-events] event context,
-  - based on `GITHUB_REF` in others event context.
+  - based on `GITHUB_REF_NAME` in other event context.
 
-**NOTE:** All enhanced variables are available in all **slug** formats.
+> [!NOTE]
+> All enhanced variables are available in all **slug** formats.
 
 ### Partial variables
 
-| Variable                                                                               | Partial version of | Description                                            |
-| -------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------ |
-| [GITHUB_REPOSITORY_OWNER_PART](docs/partial-variables.md#github_repository_owner_part) | GITHUB_REPOSITORY  | The Owner part of GITHUB_REPOSITORY variable           |
-| [GITHUB_REPOSITORY_NAME_PART](docs/partial-variables.md#github_repository_name_part)   | GITHUB_REPOSITORY  | The Repository name part of GITHUB_REPOSITORY variable |
+| Variable | Description |
+| -------- | ----------- |
+| [GITHUB_REPOSITORY_OWNER_PART](docs/partial-variables.md#github_repository_owner_part) | The Owner part of GITHUB_REPOSITORY variable |
+| [GITHUB_REPOSITORY_NAME_PART](docs/partial-variables.md#github_repository_name_part) | The Repository name part of GITHUB_REPOSITORY variable |
 
 ### Slug variables
 
-**NOTE:** `_CS` suffix available
+> [!TIP]
+> Available in standard and case-sensitive (`_CS`) versions.
 
-| Variable                                                                                          | Slug version of              | Description                                                                                                          |
-| ------------------------------------------------------------------------------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| [GITHUB_REPOSITORY_SLUG](docs/slug-variables.md#github_repository_slug)                           | GITHUB_REPOSITORY            | The owner and repository name.                                                                                       |
-| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG](docs/slug-variables.md#github_repository_owner_part_slug) | GITHUB_REPOSITORY_OWNER_PART | The owner name.                                                                                                      |
-| [GITHUB_REPOSITORY<br>_NAME_PART_SLUG](docs/slug-variables.md#github_repository_name_part_slug)   | GITHUB_REPOSITORY_NAME_PART  | The repository name.                                                                                                 |
-| [GITHUB_REF_SLUG](docs/slug-variables.md#github_ref_slug)                                         | GITHUB_REF                   | The branch or tag ref that triggered the workflow.                                                                   |
-| [GITHUB_HEAD_REF_SLUG](docs/slug-variables.md#github_head_ref_slug)                               | GITHUB_HEAD_REF              | The branch of the head repository.<br>Only set for [pull-request][event-pull-request] event and forked repositories. |
-| [GITHUB_BASE_REF_SLUG](docs/slug-variables.md#github_base_ref_slug)                               | GITHUB_BASE_REF              | The branch of the base repository.<br>Only set for [pull-request][event-pull-request] event and forked repositories. |
-| [GITHUB_EVENT_REF_SLUG](docs/slug-variables.md#github_event_ref_slug)                             | _github.event.ref_           | <br>Only set for [following webhook events][webhooks-and-events]<ul><li>`create`</li><li>`delete`</li></ul>          |
+| Variable | Description |
+| -------- | ----------- |
+| [GITHUB_REPOSITORY_SLUG](docs/slug-variables.md#github_repository_slug) | The owner and repository name. |
+| [GITHUB_REPOSITORY_OWNER_PART_SLUG](docs/slug-variables.md#github_repository_owner_part_slug) | The owner name. |
+| [GITHUB_REPOSITORY_NAME_PART_SLUG](docs/slug-variables.md#github_repository_name_part_slug) | The repository name. |
+| [GITHUB_REF_SLUG](docs/slug-variables.md#github_ref_slug) | The branch or tag ref that triggered the workflow. |
+| [GITHUB_REF_NAME_SLUG](docs/slug-variables.md#github_ref_name_slug) | This value matches the branch or tag name shown on GitHub. |
+| [GITHUB_HEAD_REF_SLUG](docs/slug-variables.md#github_head_ref_slug) | The branch of the head repository. |
+| [GITHUB_BASE_REF_SLUG](docs/slug-variables.md#github_base_ref_slug) | The branch of the base repository. |
+| [GITHUB_EVENT_REF_SLUG](docs/slug-variables.md#github_event_ref_slug) | The Git reference resource associated to triggered webhook. |
 
-### Slug URL variables
+### URL-Safe Slug variables
 
-**NOTE:** `_CS` suffix available
+Same as slug variables but URL-compliant
 
-| Variable                                                                                                  | Slug URL version of          | Description                                                                                                           |
-| --------------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| [GITHUB_REPOSITORY_SLUG_URL](docs/slug-url-variables.md#github_repository_slug_url)                       | GITHUB_REPOSITORY            | The owner and repository name.                                                                                        |
-| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG_URL](docs/slug-variables.md#github_repository_owner_part_slug_url) | GITHUB_REPOSITORY_OWNER_PART | The owner name.                                                                                                       |
-| [GITHUB_REPOSITORY<br>_NAME_PART_SLUG_URL](docs/slug-variables.md#github_repository_name_part_slug_url)   | GITHUB_REPOSITORY_NAME_PART  | The repository name.                                                                                                  |
-| [GITHUB_REF_SLUG_URL](docs/slug-url-variables.md#github_ref_slug_url)                                     | GITHUB_REF                   | The branch or tag ref that triggered the workflow.                                                                    |
-| [GITHUB_HEAD_REF_SLUG_URL](docs/slug-url-variables.md#github_head_ref_slug_url)                           | GITHUB_HEAD_REF              | The branch of the head repository.<br>Only set for [pull-request][webhooks-and-events] event and forked repositories. |
-| [GITHUB_BASE_REF_SLUG_URL](docs/slug-url-variables.md#github_base_ref_slug_url)                           | GITHUB_BASE_REF              | The branch of the base repository.<br>Only set for [pull-request][webhooks-and-events] event and forked repositories. |
-| [GITHUB_EVENT_REF_SLUG_URL](docs/slug-url-variables.md#github_event_ref_slug_url)                         | _github.event.ref_           | <br>Only set for [following webhook events][webhooks-and-events]<ul><li>`create`</li><li>`delete`</li></ul>           |
+> [!TIP]
+> Available in standard and case-sensitive (`_CS`) versions.
+
+| Variable | Description |
+| -------- | ----------- |
+| [GITHUB_REPOSITORY_SLUG_URL](docs/slug-url-variables.md#github_repository_slug_url) | The owner and repository name. |
+| [GITHUB_REPOSITORY_OWNER_PART_SLUG_URL](docs/slug-variables.md#github_repository_owner_part_slug_url) | The owner name. |
+| [GITHUB_REPOSITORY_NAME_PART_SLUG_URL](docs/slug-variables.md#github_repository_name_part_slug_url) | The repository name. |
+| [GITHUB_REF_SLUG_URL](docs/slug-url-variables.md#github_ref_slug_url) | The branch or tag ref that triggered the workflow. |
+| [GITHUB_REF_NAME_SLUG_URL](docs/slug-url-variables.md#github_ref_slug_url) | This value matches the branch or tag name shown on GitHub. |
+| [GITHUB_HEAD_REF_SLUG_URL](docs/slug-url-variables.md#github_head_ref_slug_url) | The branch of the head repository. |
+| [GITHUB_BASE_REF_SLUG_URL](docs/slug-url-variables.md#github_base_ref_slug_url) | The branch of the base repository. |
+| [GITHUB_EVENT_REF_SLUG_URL](docs/slug-url-variables.md#github_event_ref_slug_url) | The Git reference resource associated to triggered webhook. |
 
 ### Short variables
 
-| Variable                                                                                                             | Short version of                             | Description                                                                                                                                                                                                                                             |
-| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [GITHUB_SHA_SHORT](docs/short-variables.md#github_sha_short)                                                         | GITHUB_SHA                                   | The commit SHA that triggered the workflow.                                                                                                                                                                                                             |
-| [GITHUB_EVENT<br>_PULL_REQUEST<br>_HEAD_SHA_SHORT](docs/short-variables.md#github_event_pull_request_head_sha_short) | _github.event<br>.pull_request<br>.head.sha_ | The commit SHA on pull request that trigger workflow.<br>Only set for [following webhook events][webhooks-and-events]<ul><li>`pull_request`</li><li>`pull_request_review`</li><li>`pull_request_review_comment`</li><li>`pull_request_target`</li></ul> |
+| Variable | Description |
+| -------- | ----------- |
+| [GITHUB_SHA_SHORT](docs/short-variables.md#github_sha_short) | The commit SHA that triggered the workflow. |
+| [GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT](docs/short-variables.md#github_event_pull_request_head_sha_short) |  The commit SHA on pull request that trigger workflow. |
+
+## Migration from previous versions
+
+### v4 to v5
+
+The **GITHUB_REF_NAME SLUG/SLUG_URL** variables don't work the same way as before
+
+> [!TIP]
+> If you use `v5` or related versions, you need to use `GITHUB_REF_POINT` instead of `GITHUB_REF_NAME` to get the behaviour of the `v4` action.
+
+Before `v5`, the behaviour was the same as the GitHub one except on `pull_request*` workflows ([Ready the full story][issue-104]).
+
+- `${{ env.GITHUB_REF_NAME }}` will serve the behaviour of this action,
+- `$GITHUB_REF_NAME` will serve the behaviour of GitHub Action.
+
+On `pull_request*` workflows, the content will be `<PR-number>/merge` instead of the branch name.
+So you need to use `GITHUB_REF_POINT` instead
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+  - run: |
+      echo "Branch Name: ${GITHUB_REF_POINT}"
+    shell: bash
+
+```
+
+Then `${{ env.GITHUB_REF_POINT }}`, and `$GITHUB_REF_POINT` will serve the behaviour of this action.
+And `${{ env.GITHUB_REF_NAME }}`, and `$GITHUB_REF_NAME` will serve the behaviour of GitHub Action.
+
+### v3 to v4
+
+Since `v4`, Git manages the short variables using [`git rev-parse`][git-revparse] behaviour.
+The length of a short sha depends on the size of **your repository** and can differ over time.
+
+To manage that moving length, you can use the `short-length` input
+
+- set `7` to reproduce `small repository` behaviour
+- set `8` to reproduce `v3` behaviour
+
+> [!WARNING]
+> The minimum length is 4, the default is the effective value of the [core.abbrev][git-core-abbrev] configuration variable.
+
+So to reproduce previous behaviour, use
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+    with:
+      short-length: 8 # Same as v3 and before
+```
 
 ## Troubleshooting
 
-### The SHORT variables doesn't have the same lengths as before
-
-Since `v4`, it's git who manage the short variables by using [git rev-parse][git-revparse] behaviour.
-The length of a short sha depends of the size of our repository and can differ over time.
-
-To manage that moving length, you can use `short-length` input
-
-- set `7` to reproduce `small repository` behavior
-- set `8` to reproduce `v3` behavior
-
-**Warning**: The minimum length is 4, the default is the effective value of the [core.abbrev][git-core-abbrev] configuration variable.
-
 ### One of the environment variables doesn't work as intended
 
-[**Note**][naming-conventions]: When you set a custom environment variable, you cannot use any of the default environment variable names. For a complete list of these, see [Default environment variables][default-environment-variables]. **If you attempt to override the value of one of these default environment variables, the assignment is ignored.**
+> [!WARNING]
+> When you set a custom environment variable, you [cannot use any of the default environment variable names][naming-conventions]. For a complete list of these, see [Default environment variables][default-environment-variables]. **If you attempt to override the value of one of these default environment variables, the assignment is ignored.**
 
-If a variable start to be used as default environment variable, the environment variable may have a different behavior than the expected one.
+If a variable starts to be used as a default environment variable, the environment variable may behave differently than the expected one.
 
 If this append, the `${{ env.GITHUB_AWESOME_VARIABLE }}` and `$GITHUB_AWESOME_VARIABLE` expression will not works in the same way.
 
-- `${{ env.GITHUB_AWESOME_VARIABLE }}` will serve the behavior of this action,
-- `$GITHUB_AWESOME_VARIABLE` will serve the behavior of GitHub Action.
+- `${{ env.GITHUB_AWESOME_VARIABLE }}` will serve the behaviour of this action,
+- `$GITHUB_AWESOME_VARIABLE` will serve the behaviour of GitHub Action.
 
-Otherwise the two expression will serve the behavior of this action.
-This will not occurs if you use the `prefix` input to avoid the issue.
+Otherwise, the two expressions will serve the behaviour of this action.
+This will not occur if you use the `prefix` input to avoid the issue.
 
-**NOTE:** If detected, the maintainers of this action will choose the best course of action depending of the impact.
-
-#### Known environment variable conflicts
-
-##### GITHUB_REF_NAME
-
-The behavior is the same as the GitHub one except on `pull_request*` workflows ([Ready the full story][issue-104]).
-
-- `${{ env.GITHUB_REF_NAME }}` will serve the behavior of this action,
-- `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
-
-On `pull_request*` workflows, the content will be `<PR-number>/merge` instead of the branch name.
-
-A possible workaround is to use `prefix` input
-
-```yaml
-- name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v4
-  with:
-    prefix: CI_
-```
-
-Then `${{ env.CI_GITHUB_REF_NAME }}`, and `$CI_GITHUB_REF_NAME` will serve the behavior of this action.
-And `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
+> [!IMPORTANT]
+> If detected, the maintainers of this action will choose the best course of action depending on the impact.
 
 ### An action could not be found at the URI
 
-If your workflow fail on the `Set up job` task with this kind of log
+If your workflow fails on the `Set up job` task with this kind of log
 
 ```text
 Download action repository 'rlespinasse/github-slug-action@GIT_REFERENCE'
@@ -232,36 +231,54 @@ Download action repository 'rlespinasse/github-slug-action@GIT_REFERENCE'
 
 If the `GIT_REFERENCE` value is
 
-- `v4.x` or after, the branch don't exists anymore following the [end-of-life for a branch](SECURITY.md#end-of-life-of-a-branch) security process.
-- `master`, the branch don't exists anymore, read more about it on the corresponding issue ([EOL issue][issue-15])
+- `v4.x` or after, following the [end-of-life for a branch](SECURITY.md#end-of-life-of-a-branch) security process, this branch can be deleted.
+- `master`, the branch doesn't exist anymore, read more about it on the corresponding issue ([EOL issue][issue-15])
 
-Please, use the current major tag `v4` or a version tag (see [releases pages][releases]) in order to fix your workflow.
+Please, use the current **Major tag** `v5` or a version tag (see [releases pages][releases]) to fix your workflow.
 
 ## Thanks for talking about us
 
-- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1] (in french :fr:)
+In English :gb:
+
 - [Action spotlight by Michael Heap][article-2]
 - [Serverless Deploy Previews on GitHub Actions][article-3]
-- [Let's Build a Continuous Delivery and Branching Process with Github Actions, Vercel and Heroku][article-4]
-- [Github Actions : enfin des pipelines accessibles aux développeurs][talk-1] (in french :fr:)
-- The next one is you. _Don't hesitate to add youself to this list._
+- [Let's Build a Continuous Delivery and Branching Process with GitHub Actions, Vercel and Heroku][article-4]
+- [Celebrating 5 Years of github-slug-action on sfeir.dev][article-7]
 
-[examples]: https://github.com/rlespinasse/github-slug-action/tree/v4.x/examples
+In French :fr:
+
+- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1]
+- [GitHub Actions : enfin des pipelines accessibles aux développeurs][talk-1]
+- [GitHub-slug-action : 5 ans d'open source pour cette GitHub Action essentielle au CI/CD][article-6]
+
+In Chinese :cn:
+
+- [利用github-slug-action暴漏GitHub Action上下文中的关键变量][article-5]
+
+> The next one is you. _Don't hesitate to add yourself to one of these lists._
+
+[examples]: https://github.com/rlespinasse/github-slug-action/tree/v5.x/examples
 [custom-variable]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
 [releases]: https://github.com/rlespinasse/github-slug-action/releases
 [issue-15]: https://github.com/rlespinasse/github-slug-action/issues/15
 [issue-104]: https://github.com/rlespinasse/github-slug-action/issues/104
 
+[slugify-value]: https://github.com/rlespinasse/slugify-value
+[shortify-git-revision]: https://github.com/rlespinasse/shortify-git-revision
+
 [git-revparse]: https://git-scm.com/docs/git-rev-parse#Documentation/git-rev-parse.txt---shortlength
 [git-core-abbrev]: https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreabbrev
 
-[default-environment-variables]: https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
+[default-environment-variables]: https://docs.github.com/en/actions/reference/workflows-and-actions/variables#default-environment-variables
 [dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
 [webhooks-and-events]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
-[naming-conventions]: https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables
+[naming-conventions]: https://docs.github.com/en/actions/reference/workflows-and-actions/variables#naming-conventions-for-configuration-variables
 
 [article-1]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8
 [article-2]: https://michaelheap.com/github-slug-action/
 [article-3]: https://barstool.engineering/serverless-deploy-previews-on-github-actions/
 [article-4]: https://javascript.plainenglish.io/lets-build-a-continuous-delivery-and-branching-process-c27dae09f0b6
+[article-5]: https://eryajf.github.io/HowToStartOpenSource/views/03-github-tips/10-Use-github-slug-action-to-leak-key-variables-in-the-Github-Action-context.html
+[article-6]: https://www.sfeir.dev/5-ans-de-github-slug-action-une-aventure-open-source/
+[article-7]: https://www.romainlespinasse.dev/posts/celebrating-5-years-of-github-slug-action/
 [talk-1]: https://www.youtube.com/watch?v=F5mBDmOQcvE

SECURITY.md

@@ -2,34 +2,26 @@
 
 ## Supported Versions and Branches
 
-We only support 2 major versions for security patches
+| Version | Supported          | End of Support | Branch | Specific Tags |
+| ------- | ------------------ | -------------- | ------ | ------------- |
+| 5.x     | :white_check_mark: |                | v5.x   | v5            |
+| 4.x     | :x:                | 2025-01-31     |        | v4.x, v4      |
+| 3.x     | :x:                | 2024-01-31     |        | v3.x, v3      |
+| 2.x     | :x:                | 2021-04-05     |        | v2.x, 2.2.0   |
+| 1.x     | :x:                | 2021-04-05     |        | v1.1.x, 1.2.0 |
+| 1.0.x   | :x:                | 2019-11-07     |        | 1.0.2         |
 
-| Version | Branch | Supported          | Specific Tags |
-| ------- | ------ | ------------------ | ------------- |
-| 4.x     | v4.x   | :white_check_mark: | v4            |
-| 3.x     | v3.x   | :white_check_mark: |               |
-| < 2.x   |        | :x:                | v2.x, v1.1.x  |
-
-A GitHub repository can used one of the available branches as action inside its workflows.
+A GitHub repository can use one of the available branches as an action inside its workflows.
 
 ### End of Life of a branch
 
-When a branch is not supported anymore, the following process occurs
+Since `2023-10-20`, when a new major version is released,
 
-- Since `v4.x` branch, the branch will be deleted 2 major versions after
-  - So `v4.x` branch will be deleted when `v7.x` branch will have its first release
-  - prefer the `v4` tag to `v4.x` branch as reference in our workflow, 
-- Before `v4.x` branch, the branch will be converted into a tag when the support is dropped
-  - So `v3.x` branch will be converted as tag when `v5.x` branch will have its first release
+- The previous one will continue to receive security patches for 3 months,
+- After the 3 months, the branch is deleted, and only the tags remain.
 
 ## Reporting a Vulnerability
 
-You can report a Vulnerability by [my email](mailto:romain.lespinasse@gmail.com).
+In this project, you can report a Vulnerability by creating a [draft security advisory](https://github.com/rlespinasse/github-slug-action/security/advisories).
 
-_Vulnerability stages :_
-
-- Reported,
-- Confirmed (or declined),
-- Fixed on maintained version series.
-
-After a vulnerability fix, an GitHub issue will be created as document this vulnerability.
+If the vulnerability is confirmed, a fix will be produced and the advisory will be published.

action.yml

@@ -59,7 +59,12 @@ runs:
     - uses: rlespinasse/slugify-value@v1.4.0
       with:
         key: GITHUB_REF_NAME
-        # Related to https://github.com/rlespinasse/github-slug-action/issues/104
+        value: ${{ github.ref_name }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@v1.4.0
+      with:
+        key: GITHUB_REF_POINT
         value: ${{ env.GITHUB_HEAD_REF_RAW || env.GITHUB_REF_NAME_RAW }}
         prefix: ${{ inputs.prefix }}
         slug-maxlength: ${{ inputs.slug-maxlength }}

docs/github-variables.md

@@ -12,10 +12,10 @@ All `GitHub` variables availables in your workflow in addition of ones exposed b
     - [Action-managed Event Variables](#action-managed-event-variables)
       - [create](#create)
       - [delete](#delete)
-      - [pull_request](#pull_request)
-      - [pull_request_review](#pull_request_review)
-      - [pull_request_review_comment](#pull_request_review_comment)
-      - [pull_request_target](#pull_request_target)
+      - [pull\_request](#pull_request)
+      - [pull\_request\_review](#pull_request_review)
+      - [pull\_request\_review\_comment](#pull_request_review_comment)
+      - [pull\_request\_target](#pull_request_target)
 
 ## Default environment variables
 
@@ -23,13 +23,14 @@ Read the official documentation about [Default environment variables][1].
 
 ### Action-managed Environment Variables
 
-| Action-managed Variables | Can be suffix by     |
-| ------------------------ | -------------------- |
-| GITHUB_REPOSITORY        | `_SLUG`, `_SLUG_URL` |
-| GITHUB_REF               | `_SLUG`, `_SLUG_URL` |
-| GITHUB_HEAD_REF          | `_SLUG`, `_SLUG_URL` |
-| GITHUB_BASE_REF          | `_SLUG`, `_SLUG_URL` |
-| GITHUB_SHA               | `_SHORT`             |
+| Action-managed Variables | Can be suffix by |
+| ------------------------ | --------------- |
+| GITHUB_REPOSITORY | `_SLUG`, `_SLUG_URL` |
+| GITHUB_REF | `_SLUG`, `_SLUG_URL` |
+| GITHUB_REF_NAME | `_SLUG`, `_SLUG_URL` |
+| GITHUB_HEAD_REF | `_SLUG`, `_SLUG_URL` |
+| GITHUB_BASE_REF | `_SLUG`, `_SLUG_URL` |
+| GITHUB_SHA | `_SHORT` |
 
 ## Variables from events
 
@@ -41,50 +42,50 @@ Read the official documentation about [Events that trigger workflows][2].
 
 Checkout [create][3] webhook payload content
 
-| Action-managed Variables | Available as              |
-| ------------------------ | ------------------------- |
-| github.event.ref         | GITHUB_EVENT_REF_SLUG     |
-| github.event.ref         | GITHUB_EVENT_REF_SLUG_URL |
+| Action-managed Variables | Available as |
+| ------------------------ | ------------ |
+| github.event.ref | GITHUB_EVENT_REF_SLUG |
+| github.event.ref | GITHUB_EVENT_REF_SLUG_URL |
 
 #### delete
 
 Checkout [delete][4] webhook payload content
 
-| Action-managed Variables | Available as              |
-| ------------------------ | ------------------------- |
-| github.event.ref         | GITHUB_EVENT_REF_SLUG     |
-| github.event.ref         | GITHUB_EVENT_REF_SLUG_URL |
+| Action-managed Variables | Available as |
+| ------------------------ | ------------ |
+| github.event.ref | GITHUB_EVENT_REF_SLUG |
+| github.event.ref | GITHUB_EVENT_REF_SLUG_URL |
 
 #### pull_request
 
 Checkout [pull_request][5] webhook payload content
 
-| Action-managed Variables           | Available as                             |
-| ---------------------------------- | ---------------------------------------- |
+| Action-managed Variables | Available as |
+| ------------------------ | ------------ |
 | github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
 
 #### pull_request_review
 
 Checkout [pull_request_review][6] webhook payload content
 
-| Action-managed Variables           | Available as                             |
-| ---------------------------------- | ---------------------------------------- |
+| Action-managed Variables | Available as |
+| ------------------------ | ------------ |
 | github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
 
 #### pull_request_review_comment
 
 Checkout [pull_request_review_comment][7] webhook payload content
 
-| Action-managed Variables           | Available as                             |
-| ---------------------------------- | ---------------------------------------- |
+| Action-managed Variables | Available as |
+| ------------------------ | ------------ |
 | github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
 
 #### pull_request_target
 
 Checkout [pull_request][5] webhook payload content
 
-| Action-managed Variables           | Available as                             |
-| ---------------------------------- | ---------------------------------------- |
+| Action-managed Variables | Available as |
+| ------------------------ | ------------ |
 | github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
 
 [1]: https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables

docs/partial-variables.md

@@ -4,25 +4,25 @@
 
 - [Partial Variables](#partial-variables)
   - [Table of Contents](#table-of-contents)
-  - [GITHUB_REPOSITORY_OWNER_PART](#github_repository_owner_part)
-  - [GITHUB_REPOSITORY_NAME_PART](#github_repository_name_part)
+  - [GITHUB\_REPOSITORY\_OWNER\_PART](#github_repository_owner_part)
+  - [GITHUB\_REPOSITORY\_NAME\_PART](#github_repository_name_part)
 
 ## GITHUB_REPOSITORY_OWNER_PART
 
 Owner part of the environment variable **GITHUB_REPOSITORY**
 
-| GITHUB_REPOSITORY            | GITHUB_REPOSITORY_OWNER_PART |
-| ---------------------------- | ---------------------------- |
-| octocat/Hello-World          | octocat                      |
-| rlespinasse/Hello-World.go   | rlespinasse                  |
-| AnotherPerson/SomeRepository | AnotherPerson                |
+| GITHUB_REPOSITORY | GITHUB_REPOSITORY_OWNER_PART |
+| ----------------- | ---------------------------- |
+| octocat/Hello-World | octocat |
+| rlespinasse/Hello-World.go | rlespinasse |
+| AnotherPerson/SomeRepository | AnotherPerson |
 
 ## GITHUB_REPOSITORY_NAME_PART
 
 Repository name part of the environment variable **GITHUB_REPOSITORY**
 
-| GITHUB_REPOSITORY            | GITHUB_REPOSITORY_NAME_PART |
-| ---------------------------- | --------------------------- |
-| octocat/Hello-World          | Hello-World                 |
-| rlespinasse/Hello-World.go   | Hello-World.go              |
-| AnotherPerson/SomeRepository | SomeRepository              |
+| GITHUB_REPOSITORY | GITHUB_REPOSITORY_NAME_PART |
+| ----------------- | --------------------------- |
+| octocat/Hello-World | Hello-World |
+| rlespinasse/Hello-World.go | Hello-World.go |
+| AnotherPerson/SomeRepository | SomeRepository |

docs/short-variables.md

@@ -4,8 +4,8 @@
 
 - [Short Variables](#short-variables)
   - [Table of Contents](#table-of-contents)
-  - [GITHUB_SHA_SHORT](#github_sha_short)
-  - [GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT](#github_event_pull_request_head_sha_short)
+  - [GITHUB\_SHA\_SHORT](#github_sha_short)
+  - [GITHUB\_EVENT\_PULL\_REQUEST\_HEAD\_SHA\_SHORT](#github_event_pull_request_head_sha_short)
 
 ## GITHUB_SHA_SHORT
 
@@ -13,15 +13,15 @@ Short the environment variable **GITHUB_SHA**
 
 The commit SHA that triggered the workflow
 
-| GITHUB_SHA                               | GITHUB_SHA_SHORT |
-| ---------------------------------------- | ---------------- |
-| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e         |
+| GITHUB_SHA | GITHUB_SHA_SHORT |
+| ---------- | ---------------- |
+| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e |
 
 ## GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT
 
 Short the value of `github.event.pull_request.head.sha` that represents the last commit
 used for triggering an action for a pull request.
 
-| github.event.pull_request.head.sha       | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
-| ---------------------------------------- | ---------------------------------------- |
-| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e                                 |
+| github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
+| ---------------------------------- | ---------------------------------------- |
+| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e |

docs/slug-url-variables.md

@@ -4,13 +4,14 @@
 
 - [Slug URL Variables](#slug-url-variables)
   - [Table of Contents](#table-of-contents)
-  - [GITHUB_REPOSITORY_SLUG_URL](#github_repository_slug_url)
-  - [GITHUB_REPOSITORY_OWNER_PART_SLUG_URL](#github_repository_owner_part_slug_url)
-  - [GITHUB_REPOSITORY_NAME_PART_SLUG_URL](#github_repository_name_part_slug_url)
-  - [GITHUB_REF_SLUG_URL](#github_ref_slug_url)
-  - [GITHUB_HEAD_REF_SLUG_URL](#github_head_ref_slug_url)
-  - [GITHUB_BASE_REF_SLUG_URL](#github_base_ref_slug_url)
-  - [GITHUB_EVENT_REF_SLUG_URL](#github_event_ref_slug_url)
+  - [GITHUB\_REPOSITORY\_SLUG\_URL](#github_repository_slug_url)
+  - [GITHUB\_REPOSITORY\_OWNER\_PART\_SLUG\_URL](#github_repository_owner_part_slug_url)
+  - [GITHUB\_REPOSITORY\_NAME\_PART\_SLUG\_URL](#github_repository_name_part_slug_url)
+  - [GITHUB\_REF\_SLUG\_URL](#github_ref_slug_url)
+  - [GITHUB\_REF\_NAME\_SLUG\_URL](#github_ref_name_slug_url)
+  - [GITHUB\_HEAD\_REF\_SLUG\_URL](#github_head_ref_slug_url)
+  - [GITHUB\_BASE\_REF\_SLUG\_URL](#github_base_ref_slug_url)
+  - [GITHUB\_EVENT\_REF\_SLUG\_URL](#github_event_ref_slug_url)
 
 ## GITHUB_REPOSITORY_SLUG_URL
 
@@ -18,10 +19,10 @@ Slug URL the environment variable **GITHUB_REPOSITORY**
 
 The owner and repository name.
 
-| GITHUB_REPOSITORY            | GITHUB_REPOSITORY_SLUG_URL   |
-| ---------------------------- | ---------------------------- |
-| octocat/Hello-World          | octocat-hello-world          |
-| rlespinasse/Hello-World.go   | rlespinasse-hello-world-go   |
+| GITHUB_REPOSITORY | GITHUB_REPOSITORY_SLUG_URL |
+| ----------------- | ---------------------------- |
+| octocat/Hello-World | octocat-hello-world |
+| rlespinasse/Hello-World.go | rlespinasse-hello-world-go |
 | AnotherPerson/SomeRepository | anotherperson-somerepository |
 
 ## GITHUB_REPOSITORY_OWNER_PART_SLUG_URL
@@ -32,9 +33,9 @@ The Owner part of **GITHUB_REPOSITORY** variable.
 
 | GITHUB_REPOSITORY_OWNER_PART | GITHUB_REPOSITORY_OWNER_PART_SLUG_URL |
 | ---------------------------- | ------------------------------------- |
-| octocat                      | octocat                               |
-| rlespinasse                  | rlespinasse                           |
-| AnotherPerson                | anotherperson                         |
+| octocat | octocat |
+| rlespinasse | rlespinasse |
+| AnotherPerson | anotherperson |
 
 ## GITHUB_REPOSITORY_NAME_PART_SLUG_URL
 
@@ -44,9 +45,9 @@ The Repository name part of **GITHUB_REPOSITORY** variable.
 
 | GITHUB_REPOSITORY_NAME_PART | GITHUB_REPOSITORY_NAME_PART_SLUG_URL |
 | --------------------------- | ------------------------------------ |
-| Hello-World                 | hello-world                          |
-| Hello-World.go              | hello-world-go                       |
-| SomeRepository              | somerepository                       |
+| Hello-World | hello-world |
+| Hello-World.go | hello-world-go |
+| SomeRepository | somerepository |
 
 ## GITHUB_REF_SLUG_URL
 
@@ -55,17 +56,30 @@ Slug URL the environment variable **GITHUB_REF**
 The branch or tag ref that triggered the workflow.
 _If neither a branch or tag is available for the event type, the variable will not exist._
 
-| GITHUB_REF                     | GITHUB_REF_SLUG_URL |
-| ------------------------------ | ------------------- |
-| refs/heads/main                | main                |
-| refs/heads/feat/new_feature    | feat-new-feature    |
-| refs/tags/v1.0.0               | v1-0-0              |
-| refs/pull/42-merge             | 42-merge            |
-| refs/tags/product@1.0.0-rc.2   | product-1-0-0-rc-2  |
+| GITHUB_REF | GITHUB_REF_SLUG_URL |
+| ---------- | ------------------- |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/tags/v1.0.0 | v1-0-0 |
+| refs/pull/42/merge | 42-merge |
+| refs/tags/product@1.0.0-rc.2 | product-1-0-0-rc-2 |
 | refs/heads/New_Awesome_Product | new-awesome-product |
 
-**Caution**: From v3.0.0 to v3.2.0 included, `GITHUB_REF_SLUG` have the wrong value on `pull_request` event.
-`refs/pull/42-merge` become `refs-pull-42-merge` instead of `42-merge`. The bug have been fixed in v3.3.0
+## GITHUB_REF_NAME_SLUG_URL
+
+Slug URL the environment variable **GITHUB_REF_NAME**
+
+The branch or tag ref that triggered the workflow.
+_If neither a branch or tag is available for the event type, the variable will not exist._
+
+| GITHUB_REF_NAME | GITHUB_REF_SLUG_URL |
+| --------------- | ------------------- |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/tags/v1.0.0 | v1-0-0 |
+| refs/pull/42/merge | 42-merge |
+| refs/tags/product@1.0.0-rc.2 | product-1-0-0-rc-2 |
+| refs/heads/New_Awesome_Product | new-awesome-product |
 
 ## GITHUB_HEAD_REF_SLUG_URL
 
@@ -74,11 +88,11 @@ Slug URL the environment variable **GITHUB_HEAD_REF**
 The branch of the head repository.
 _Only set for forked repositories._
 
-| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG_URL |
-| ------------------------------ | ------------------------ |
-| refs/heads/main                | main                     |
-| refs/heads/feat/new_feature    | feat-new-feature         |
-| refs/heads/New_Awesome_Product | new-awesome-product      |
+| GITHUB_REF | GITHUB_HEAD_REF_SLUG_URL |
+| ---------- | ------------------------ |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/heads/New_Awesome_Product | new-awesome-product |
 
 ## GITHUB_BASE_REF_SLUG_URL
 
@@ -87,23 +101,23 @@ Slug URL the environment variable **GITHUB_BASE_REF**
 The branch of the base repository.
 _Only set for forked repositories._
 
-| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG_URL |
-| ------------------------------ | ------------------------ |
-| refs/heads/main                | main                     |
-| refs/heads/feat/new_feature    | feat-new-feature         |
-| refs/heads/New_Awesome_Product | new-awesome-product      |
+| GITHUB_REF | GITHUB_HEAD_REF_SLUG_URL |
+| ---------- | ------------------------ |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/heads/New_Awesome_Product | new-awesome-product |
 
 ## GITHUB_EVENT_REF_SLUG_URL
 
 Slug URL the variable **github.event.ref**
 
-The git reference resource associated to triggered webhook.
+The Git reference resource associated to triggered webhook.
 _Only set for [`create`, and `delete`][1] events._
 
-| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG_URL |
-| ------------------------------ | ------------------------ |
-| refs/heads/main                | main                     |
-| refs/heads/feat/new_feature    | feat-new-feature         |
-| refs/heads/New_Awesome_Product | new-awesome-product      |
+| GITHUB_REF | GITHUB_HEAD_REF_SLUG_URL |
+| ---------- | ------------------------ |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/heads/New_Awesome_Product | new-awesome-product |
 
 [1]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads

docs/slug-variables.md

@@ -4,13 +4,14 @@
 
 - [Slug Variables](#slug-variables)
   - [Table of Contents](#table-of-contents)
-  - [GITHUB_REPOSITORY_SLUG](#github_repository_slug)
-  - [GITHUB_REPOSITORY_OWNER_PART_SLUG](#github_repository_owner_part_slug)
-  - [GITHUB_REPOSITORY_NAME_PART_SLUG](#github_repository_name_part_slug)
-  - [GITHUB_REF_SLUG](#github_ref_slug)
-  - [GITHUB_HEAD_REF_SLUG](#github_head_ref_slug)
-  - [GITHUB_BASE_REF_SLUG](#github_base_ref_slug)
-  - [GITHUB_EVENT_REF_SLUG](#github_event_ref_slug)
+  - [GITHUB\_REPOSITORY\_SLUG](#github_repository_slug)
+  - [GITHUB\_REPOSITORY\_OWNER\_PART\_SLUG](#github_repository_owner_part_slug)
+  - [GITHUB\_REPOSITORY\_NAME\_PART\_SLUG](#github_repository_name_part_slug)
+  - [GITHUB\_REF\_SLUG](#github_ref_slug)
+  - [GITHUB\_REF\_NAME\_SLUG](#github_ref_name_slug)
+  - [GITHUB\_HEAD\_REF\_SLUG](#github_head_ref_slug)
+  - [GITHUB\_BASE\_REF\_SLUG](#github_base_ref_slug)
+  - [GITHUB\_EVENT\_REF\_SLUG](#github_event_ref_slug)
 
 ## GITHUB_REPOSITORY_SLUG
 
@@ -18,10 +19,10 @@ Slug the environment variable **GITHUB_REPOSITORY**
 
 The owner and repository name.
 
-| GITHUB_REPOSITORY            | GITHUB_REPOSITORY_SLUG       |
-| ---------------------------- | ---------------------------- |
-| octocat/Hello-World          | octocat-hello-world          |
-| rlespinasse/Hello-World.go   | rlespinasse-hello-world.go   |
+| GITHUB_REPOSITORY | GITHUB_REPOSITORY_SLUG |
+| ----------------- | ---------------------- |
+| octocat/Hello-World | octocat-hello-world |
+| rlespinasse/Hello-World.go | rlespinasse-hello-world.go |
 | AnotherPerson/SomeRepository | anotherperson-somerepository |
 
 ## GITHUB_REPOSITORY_OWNER_PART_SLUG
@@ -32,9 +33,9 @@ The Owner part of **GITHUB_REPOSITORY** variable.
 
 | GITHUB_REPOSITORY_OWNER_PART | GITHUB_REPOSITORY_OWNER_PART_SLUG |
 | ---------------------------- | --------------------------------- |
-| octocat                      | octocat                           |
-| rlespinasse                  | rlespinasse                       |
-| AnotherPerson                | anotherperson                     |
+| octocat | octocat |
+| rlespinasse | rlespinasse |
+| AnotherPerson | anotherperson |
 
 ## GITHUB_REPOSITORY_NAME_PART_SLUG
 
@@ -44,9 +45,9 @@ The Repository name part of **GITHUB_REPOSITORY** variable.
 
 | GITHUB_REPOSITORY_NAME_PART | GITHUB_REPOSITORY_NAME_PART_SLUG |
 | --------------------------- | -------------------------------- |
-| Hello-World                 | hello-world                      |
-| Hello-World.go              | hello-world.go                   |
-| SomeRepository              | somerepository                   |
+| Hello-World | hello-world |
+| Hello-World.go | hello-world.go |
+| SomeRepository | somerepository |
 
 ## GITHUB_REF_SLUG
 
@@ -55,14 +56,30 @@ Slug the environment variable **GITHUB_REF**
 The branch or tag ref that triggered the workflow.
 _If neither a branch or tag is available for the event type, the variable will not exist._
 
-| GITHUB_REF                     | GITHUB_REF_SLUG     |
-| ------------------------------ | ------------------- |
-| refs/heads/main                | main                |
-| refs/heads/feat/new_feature    | feat-new-feature    |
-| refs/tags/v1.0.0               | v1.0.0              |
-| refs/tags/product@1.0.0-rc.2   | product-1.0.0-rc.2  |
+| GITHUB_REF | GITHUB_REF_SLUG |
+| ---------- | --------------- |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/tags/v1.0.0 | v1.0.0 |
+| refs/tags/product@1.0.0-rc.2 | product-1.0.0-rc.2 |
 | refs/heads/New_Awesome_Product | new-awesome-product |
 
+## GITHUB_REF_NAME_SLUG
+
+Slug the environment variable **GITHUB_REF_NAME**
+
+The branch or tag ref that triggered the workflow.
+_If neither a branch or tag is available for the event type, the variable will not exist._
+
+| GITHUB_REF_NAME | GITHUB_REF_SLUG |
+| --------------- | --------------- |
+| main | main |
+| feat/new_feature | feat-new-feature |
+| v1.0.0 | v1.0.0 |
+| product@1.0.0-rc.2 | product-1.0.0-rc.2 |
+| New_Awesome_Product | new-awesome-product |
+| 42/merge | 42-merge |
+
 ## GITHUB_HEAD_REF_SLUG
 
 Slug the environment variable **GITHUB_HEAD_REF**
@@ -70,11 +87,11 @@ Slug the environment variable **GITHUB_HEAD_REF**
 The branch of the head repository.
 _Only set for [`pull-request`][1] event and forked repositories._
 
-| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG |
-| ------------------------------ | -------------------- |
-| refs/heads/main                | main                 |
-| refs/heads/feat/new_feature    | feat-new-feature     |
-| refs/heads/New_Awesome_Product | new-awesome-product  |
+| GITHUB_REF | GITHUB_HEAD_REF_SLUG |
+| ---------- | -------------------- |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/heads/New_Awesome_Product | new-awesome-product |
 
 ## GITHUB_BASE_REF_SLUG
 
@@ -83,23 +100,23 @@ Slug the environment variable **GITHUB_BASE_REF**
 The branch of the base repository.
 _Only set for [`pull-request`][1] event and forked repositories._
 
-| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG |
-| ------------------------------ | -------------------- |
-| refs/heads/main                | main                 |
-| refs/heads/feat/new_feature    | feat-new-feature     |
-| refs/heads/New_Awesome_Product | new-awesome-product  |
+| GITHUB_REF | GITHUB_HEAD_REF_SLUG |
+| ---------- | -------------------- |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/heads/New_Awesome_Product | new-awesome-product |
 
 ## GITHUB_EVENT_REF_SLUG
 
 Slug the variable **github.event.ref**
 
-The git reference resource associated to triggered webhook.
+The Git reference resource associated to triggered webhook.
 _Only set for [`create`, and `delete`][1] events._
 
-| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG |
-| ------------------------------ | -------------------- |
-| refs/heads/main                | main                 |
-| refs/heads/feat/new_feature    | feat-new-feature     |
-| refs/heads/New_Awesome_Product | new-awesome-product  |
+| GITHUB_REF | GITHUB_HEAD_REF_SLUG |
+| ---------- | -------------------- |
+| refs/heads/main | main |
+| refs/heads/feat/new_feature | feat-new-feature |
+| refs/heads/New_Awesome_Product | new-awesome-product |
 
 [1]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads

examples/linux-usage.yml

@@ -6,8 +6,8 @@ jobs:
   usage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - name: Output
         run: |
           echo "Partial variables"

examples/macos-usage.yml

@@ -6,8 +6,8 @@ jobs:
   usage:
     runs-on: macos-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - name: Output
         run: |
           echo "Partial variables"

examples/url-use.yml

@@ -6,15 +6,15 @@ jobs:
   as_subdomain:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - run: |
           ./deploy-application.sh --url "https://${{ env.GITHUB_REF_SLUG_URL }}.staging.app.example.com"
 
   as_resource_path:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - run: |
           ./deploy-application.sh --url "https://staging.app.example.com/${{ env.GITHUB_REF_SLUG_URL }}"

examples/windows-usage.yml

@@ -6,8 +6,8 @@ jobs:
   usage:
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
+      - uses: rlespinasse/github-slug-action@v5
       - name: Output
         run: |
           echo "Partial variables"