feat: bump actions/github-script from 8 to 9 (#178)

Co-authored-by: Claude <noreply@anthropic.com>

.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+ignore-words-list = ans

.dependabot/config.xml

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

.eslintignore

@@ -1,3 +0,0 @@
-dist/
-lib/
-node_modules/

.eslintrc.json

@@ -1,54 +0,0 @@
-{
-    "plugins": ["jest", "@typescript-eslint"],
-    "extends": ["plugin:github/recommended"],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-      "ecmaVersion": 9,
-      "sourceType": "module",
-      "project": "./tsconfig.json"
-    },
-    "rules": {
-      "eslint-comments/no-use": "off",
-      "import/no-namespace": "off",
-      "no-unused-vars": "off",
-      "@typescript-eslint/no-unused-vars": "error",
-      "@typescript-eslint/explicit-member-accessibility": ["error", {"accessibility": "no-public"}],
-      "@typescript-eslint/no-require-imports": "error",
-      "@typescript-eslint/array-type": "error",
-      "@typescript-eslint/await-thenable": "error",
-      "@typescript-eslint/ban-ts-comment": "error",
-      "camelcase": "off",
-      "@typescript-eslint/consistent-type-assertions": "error",
-      "@typescript-eslint/explicit-function-return-type": ["error", {"allowExpressions": true}],
-      "@typescript-eslint/func-call-spacing": ["error", "never"],
-      "@typescript-eslint/no-array-constructor": "error",
-      "@typescript-eslint/no-empty-interface": "error",
-      "@typescript-eslint/no-explicit-any": "error",
-      "@typescript-eslint/no-extraneous-class": "error",
-      "@typescript-eslint/no-for-in-array": "error",
-      "@typescript-eslint/no-inferrable-types": "error",
-      "@typescript-eslint/no-misused-new": "error",
-      "@typescript-eslint/no-namespace": "error",
-      "@typescript-eslint/no-non-null-assertion": "warn",
-      "@typescript-eslint/no-unnecessary-qualifier": "error",
-      "@typescript-eslint/no-unnecessary-type-assertion": "error",
-      "@typescript-eslint/no-useless-constructor": "error",
-      "@typescript-eslint/no-var-requires": "error",
-      "@typescript-eslint/prefer-for-of": "warn",
-      "@typescript-eslint/prefer-function-type": "warn",
-      "@typescript-eslint/prefer-includes": "error",
-      "@typescript-eslint/prefer-string-starts-ends-with": "error",
-      "@typescript-eslint/promise-function-async": "error",
-      "@typescript-eslint/require-array-sort-compare": "error",
-      "@typescript-eslint/restrict-plus-operands": "error",
-      "semi": "off",
-      "@typescript-eslint/semi": ["error", "never"],
-      "@typescript-eslint/type-annotation-spacing": "error",
-      "@typescript-eslint/unbound-method": "error"
-    },
-    "env": {
-      "node": true,
-      "es6": true,
-      "jest/globals": true
-    }
-  }

.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@v9
+        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/codeql-analysis.yml

@@ -1,31 +0,0 @@
-name: '[v3] CodeQL'
-
-on:
-  push:
-    branches:
-      - v3.x
-  pull_request:
-    branches:
-      - v3.x
-  schedule:
-    - cron: '0 6 * * 1'
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  analyse:
-    name: analyze
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        language: ['javascript']
-    steps:
-      - uses: actions/checkout@v3
-      - uses: github/codeql-action/init@v2
-        with:
-          languages: ${{ matrix.language }}
-      - uses: github/codeql-action/autobuild@v2
-      - uses: github/codeql-action/analyze@v2

.github/workflows/github-slug.yml

@@ -1,74 +0,0 @@
-name: '[v3] Testing'
-on: [push]
-jobs:
-  github-slug-on-os:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [macos-latest, ubuntu-latest, windows-latest]
-    runs-on: ${{ matrix.os }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - run: npm install
-        shell: bash
-      - run: npm run all
-        shell: bash
-      - uses: ./
-      - name: Partial variables
-        run: |
-          echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART }}"
-          echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART }}"
-        shell: bash
-      - name: Slug variables
-        run: |
-          echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG }}"
-          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 "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG }}"
-          echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG }}"
-          echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG }}"
-      - 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 "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 "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 "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
-        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 }}"
-        shell: bash
-      - name: Short SHA variables
-        run: |
-          echo "sha              : ${{ env.GITHUB_SHA_SHORT }}"
-          echo "pull request sha : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
-        shell: bash

.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/release-dryrun.yml

@@ -1,29 +0,0 @@
-name: '[v3] Release DryRun'
-
-on:
-  push:
-    branches-ignore:
-      - v*.x
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-
-jobs:
-  release-dryrun:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - run: npm install
-        shell: bash
-      - run: npm run all
-        shell: bash
-      - uses: ./
-      - uses: cycjimmy/semantic-release-action@v3
-        with:
-          branches: |
-            [
-              "${{ env.GITHUB_REF_NAME }}"
-            ]
-          dry_run: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -1,22 +0,0 @@
-name: '[v3] Release'
-
-on:
-  push:
-    branches:
-      - v*.x
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - run: npm install
-        shell: bash
-      - run: npm run all
-        shell: bash
-      - uses: cycjimmy/semantic-release-action@v3
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

@@ -0,0 +1,402 @@
+name: "[v5] Test and Release"
+on: [push, pull_request]
+permissions: read-all
+jobs:
+  check-v4-compatibility:
+    name: "Check v4 compatibility"
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Load this action from HEAD
+        uses: ./
+
+      - name: Load using v4
+        uses: rlespinasse/github-slug-action@v4
+        with:
+          prefix: V4_
+
+      - name: Validate // Partial variables
+        run: |
+          [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_NAME_PART }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART }}" ]]
+        shell: bash
+
+      - name: Validate // Slug variables
+        run: |
+          [[ "${{ env.GITHUB_REPOSITORY_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG }}" ]]
+          [[ "${{ env.GITHUB_REF_SLUG }}" == "${{ env.V4_GITHUB_REF_SLUG }}" ]]
+          [[ "${{ env.GITHUB_HEAD_REF_SLUG }}" == "${{ env.V4_GITHUB_HEAD_REF_SLUG }}" ]]
+          [[ "${{ env.GITHUB_BASE_REF_SLUG }}" == "${{ env.V4_GITHUB_BASE_REF_SLUG }}" ]]
+          [[ "${{ env.GITHUB_EVENT_REF_SLUG }}" == "${{ env.V4_GITHUB_EVENT_REF_SLUG }}" ]]
+        shell: bash
+      - name: Validate // Slug variables (Case Sensitive)
+        run: |
+          [[ "${{ env.GITHUB_REPOSITORY_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_CS }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}" ]]
+          [[ "${{ env.GITHUB_REF_SLUG_CS }}" == "${{ env.V4_GITHUB_REF_SLUG_CS }}" ]]
+          [[ "${{ env.GITHUB_HEAD_REF_SLUG_CS }}" == "${{ env.V4_GITHUB_HEAD_REF_SLUG_CS }}" ]]
+          [[ "${{ env.GITHUB_BASE_REF_SLUG_CS }}" == "${{ env.V4_GITHUB_BASE_REF_SLUG_CS }}" ]]
+          [[ "${{ env.GITHUB_EVENT_REF_SLUG_CS }}" == "${{ env.V4_GITHUB_EVENT_REF_SLUG_CS }}" ]]
+        shell: bash
+      - name: Validate // Slug URL variables
+        run: |
+          [[ "${{ env.GITHUB_REPOSITORY_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_URL }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}" ]]
+          [[ "${{ env.GITHUB_REF_SLUG_URL }}" == "${{ env.V4_GITHUB_REF_SLUG_URL }}" ]]
+          [[ "${{ env.GITHUB_HEAD_REF_SLUG_URL }}" == "${{ env.V4_GITHUB_HEAD_REF_SLUG_URL }}" ]]
+          [[ "${{ env.GITHUB_BASE_REF_SLUG_URL }}" == "${{ env.V4_GITHUB_BASE_REF_SLUG_URL }}" ]]
+          [[ "${{ env.GITHUB_EVENT_REF_SLUG_URL }}" == "${{ env.V4_GITHUB_EVENT_REF_SLUG_URL }}" ]]
+        shell: bash
+      - name: Validate // Slug URL variables (Case Sensitive)
+        run: |
+          [[ "${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_SLUG_URL_CS }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}" ]]
+          [[ "${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}" ]]
+          [[ "${{ env.GITHUB_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REF_SLUG_URL_CS }}" ]]
+          [[ "${{ env.GITHUB_HEAD_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_HEAD_REF_SLUG_URL_CS }}" ]]
+          [[ "${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_BASE_REF_SLUG_URL_CS }}" ]]
+          [[ "${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_EVENT_REF_SLUG_URL_CS }}" ]]
+        shell: bash
+
+      - name: Validate // Ref Point
+        run: |
+          [[ "${{ 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
+        run: |
+          [[ "${{ env.GITHUB_SHA_SHORT }}" == "${{ env.V4_GITHUB_SHA_SHORT }}" ]]
+          [[ "${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" == "${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" ]]
+        shell: bash
+
+  check-v4-compatibility-without-checkout:
+    name: "Check v4 compatibility (without checkout)"
+    needs:
+      - check-v4-compatibility
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          path: this-action
+          ref: ${{ github.ref }}
+
+      - name: Load this action from HEAD
+        uses: ./this-action
+
+      - name: Load using v4
+        uses: rlespinasse/github-slug-action@v4
+        with:
+          prefix: V4_
+
+      - name: Validate // Short SHA variables
+        run: |
+          [[ "${{ env.GITHUB_SHA_SHORT }}" == "${{ env.V4_GITHUB_SHA_SHORT }}" ]]
+          [[ "${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" == "${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" ]]
+        shell: bash
+
+  display:
+    name: "Display produced variables"
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Load this action from HEAD
+        uses: ./
+
+      - name: Partial variables
+        run: |
+          echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART }}"
+          echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART }}"
+        shell: bash
+
+      - name: Slug variables
+        run: |
+          echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG }}"
+          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 Point
+        run: |
+          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
+        run: |
+          echo "sha              : ${{ env.GITHUB_SHA_SHORT }}"
+          echo "pull request sha : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
+        shell: bash
+
+  display-without-checkout:
+    name: "Display produced variables (without checkout)"
+    needs:
+      - display
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          path: this-action
+          ref: ${{ github.ref }}
+
+      - name: Load this action from HEAD
+        uses: ./this-action
+
+      - name: Short SHA variables
+        run: |
+          echo "sha              : ${{ env.GITHUB_SHA_SHORT }}"
+          echo "pull request sha : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
+        shell: bash
+
+  input-short-length:
+    name: "Input 'short-length'"
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      # Test 1
+      - name: Using correct short length
+        uses: ./
+        with:
+          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 [ "${#value}" -le 5 ] ; done
+        shell: bash
+
+      # Test 2
+      - name: Using wrong short length
+        id: using-wrong-short-length
+        uses: ./
+        with:
+          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" -c)" -eq 0 ]]
+          [[ "${{ steps.using-wrong-short-length.outcome }}" == "failure" ]]
+          [[ "${{ steps.using-wrong-short-length.conclusion }}" == "success" ]]
+        shell: bash
+
+  input-short-length-without-checkout:
+    name: "Input 'short-length' (without checkout)"
+    needs:
+      - input-short-length
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          path: this-action
+          ref: ${{ github.ref }}
+
+      # Test 1
+      - name: Using correct short length
+        uses: ./this-action
+        with:
+          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 [ "${#value}" -le 5 ] ; done
+        shell: bash
+
+      # Test 2
+      - name: Using empty short length
+        id: using-empty-short-length
+        uses: ./this-action
+        with:
+          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" -c)" -gt 0 ]]
+          [[ "${{ steps.using-empty-short-length.outcome }}" == "success" ]]
+          [[ "${{ steps.using-empty-short-length.conclusion }}" == "success" ]]
+        shell: bash
+
+      # Test 3
+      - name: Using wrong short length
+        id: using-wrong-short-length
+        uses: ./this-action
+        with:
+          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" -c)" -eq 0 ]]
+          [[ "${{ steps.using-wrong-short-length.outcome }}" == "failure" ]]
+          [[ "${{ steps.using-wrong-short-length.conclusion }}" == "success" ]]
+        shell: bash
+
+  input-slug-maxlength:
+    name: "Input 'slug-maxlength'"
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      # Test 1
+      - name: Using correct slug max length
+        uses: ./
+        with:
+          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 [ "${#value}" -le 2 ] ; done
+        shell: bash
+
+      # Test 2
+      - name: Using wrong slug max length
+        id: using-wrong-slug-max-length
+        uses: ./
+        with:
+          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" -c)" -eq 0 ]]
+          [[ "${{ steps.using-wrong-slug-max-length.outcome }}" == "failure" ]]
+          [[ "${{ steps.using-wrong-slug-max-length.conclusion }}" == "success" ]]
+        shell: bash
+
+      # Test 3
+      - name: Using empty slug max length
+        id: using-empty-slug-max-length
+        uses: ./
+        with:
+          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" -c)" -eq 0 ]]
+          [[ "${{ steps.using-empty-slug-max-length.outcome }}" == "failure" ]]
+          [[ "${{ steps.using-empty-slug-max-length.conclusion }}" == "success" ]]
+        shell: bash
+
+      # Test 4
+      - name: Using no limit on slug max length
+        id: using-nolimit-slug-max-length
+        uses: ./
+        with:
+          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" -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:
+      - display-without-checkout
+      - input-short-length-without-checkout
+      - input-slug-maxlength
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Release this GitHub Action
+        uses: rlespinasse/release-that@v1
+        with:
+          github-token: ${{ secrets.GH_TOKEN }}

.gitignore

@@ -1,99 +0,0 @@
-# Dependency directory
-node_modules
-
-# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# next.js build output
-.next
-
-# nuxt.js build output
-.nuxt
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# OS metadata
-.DS_Store
-Thumbs.db
-
-# Ignore built ts files
-__tests__/runner/*
-lib/**/*

.prettierignore

@@ -1,3 +0,0 @@
-dist/
-lib/
-node_modules/

.prettierrc.json

@@ -1,10 +0,0 @@
-{
-  "printWidth": 80,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": false,
-  "singleQuote": true,
-  "trailingComma": "none",
-  "bracketSpacing": false,
-  "arrowParens": "avoid"
-}

CHANGELOG.md

@@ -1,114 +0,0 @@
-# [3.9.0](https://github.com/rlespinasse/github-slug-action/compare/v3.8.0...v3.9.0) (2024-01-28)
-
-
-### Features
-
-* use node20 as action run mode ([#138](https://github.com/rlespinasse/github-slug-action/issues/138)) ([26c5c6b](https://github.com/rlespinasse/github-slug-action/commit/26c5c6b51cfc01c811f8a14ddd9d9bcb43948328))
-
-# [3.8.0](https://github.com/rlespinasse/github-slug-action/compare/v3.7.1...v3.8.0) (2023-10-20)
-
-
-### Features
-
-* use node16 as action run mode ([7bf92d8](https://github.com/rlespinasse/github-slug-action/commit/7bf92d88ffb302024ab1f11ced51360f041f1b5e))
-
-## [3.7.1](https://github.com/rlespinasse/github-slug-action/compare/v3.7.0...v3.7.1) (2022-10-15)
-
-
-### Bug Fixes
-
-* use environment file to manage outputs ([dedf4ac](https://github.com/rlespinasse/github-slug-action/commit/dedf4ac5bbb50aeb6992c8323d2862843079f1b4))
-
-# [3.7.0](https://github.com/rlespinasse/github-slug-action/compare/v3.6.1...v3.7.0) (2022-10-02)
-
-
-### Features
-
-* generate proper git tag ([68babf6](https://github.com/rlespinasse/github-slug-action/commit/68babf69b34f4c4b556ea350616c5408d627937e))
-
-## [3.6.1](https://github.com/rlespinasse/github-slug-action/compare/3.6.0...3.6.1) (2022-08-22)
-
-
-### Bug Fixes
-
-* remove trailing hyphens if any after cut ([19f9c84](https://github.com/rlespinasse/github-slug-action/commit/19f9c84ac61b17071a3cfc4ae984ac0e2ba1cdae))
-
-# [3.6.0](http://github.com/rlespinasse/github-slug-action/compare/3.5.1...3.6.0) (2021-09-15)
-
-
-### Features
-
-* add GITHUB_REF_NAME env var ([12a7510](http://github.com/rlespinasse/github-slug-action/commit/12a75106304d45442301df66d3ba38e1ac002649))
-
-## [3.5.1](http://github.com/rlespinasse/github-slug-action/compare/3.5.0...3.5.1) (2021-03-31)
-
-
-### Bug Fixes
-
-* update dist files ([e6c550f](http://github.com/rlespinasse/github-slug-action/commit/e6c550f88ccca52a82675b89186b6b72864f087c))
-
-# [3.5.0](http://github.com/rlespinasse/github-slug-action/compare/3.4.0...3.5.0) (2021-03-30)
-
-
-### Features
-
-* allow underscore in slug values ([475d293](http://github.com/rlespinasse/github-slug-action/commit/475d293680b998a3315846828329f05bfff4ac9c))
-
-# [3.4.0](http://github.com/rlespinasse/github-slug-action/compare/3.3.0...3.4.0) (2021-03-02)
-
-
-### Features
-
-* add _CS suffix to keep value case-sensitive ([6c93fcb](http://github.com/rlespinasse/github-slug-action/commit/6c93fcbf53da9c6415bd7f5e37579b488f34339e))
-
-# [3.3.0](http://github.com/rlespinasse/github-slug-action/compare/3.2.0...3.3.0) (2021-01-25)
-
-
-### Bug Fixes
-
-* support pull-request for slug and slug url ([78985f8](http://github.com/rlespinasse/github-slug-action/commit/78985f84eca97ef1c5262e85e8a73a277494c4ed))
-
-
-### Features
-
-* support partial GITHUB_REPOSITORY ([75ce03b](http://github.com/rlespinasse/github-slug-action/commit/75ce03b6a055a3be9d936a3a99c51038bd72298c))
-
-# [3.2.0](http://github.com/rlespinasse/github-slug-action/compare/3.1.0...3.2.0) (2021-01-12)
-
-
-### Features
-
-* expose GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT ([5b9fe60](http://github.com/rlespinasse/github-slug-action/commit/5b9fe6015d2facc71c81d53bf3b08f04e0f3f743))
-
-# [3.1.0](http://github.com/rlespinasse/github-slug-action/compare/3.0.0...3.1.0) (2020-11-01)
-
-
-### Features
-
-* **action:** improve marketplace information ([3cddc4f](http://github.com/rlespinasse/github-slug-action/commit/3cddc4f12d7a6fdbb8b1221dc02a2c64670e54bf))
-
-# [3.0.0](http://github.com/rlespinasse/github-slug-action/compare/2.1.0...3.0.0) (2020-10-26)
-
-
-### Bug Fixes
-
-* upgrade actions core due to CVE fix ([d0549c1](http://github.com/rlespinasse/github-slug-action/commit/d0549c1f85ab9567b439f9d660b01ce1142b9fbe))
-
-
-### Features
-
-* add support for windows and macos jobs ([13c2f38](http://github.com/rlespinasse/github-slug-action/commit/13c2f38dad5f32529f37c25736412b1e4cf687fe))
-
-
-### BREAKING CHANGES
-
-* The action implementation move from container action to node.js action
-
-Co-authored-by: Romain Lespinasse <romain.lespinasse@gmail.com>
-
-# [2.1.0](http://github.com/rlespinasse/github-slug-action/compare/2.0.0...2.1.0) (2020-07-28)
-
-
-### Features
-
-* expose slug variables for github.event.ref ([5a334a8](http://github.com/rlespinasse/github-slug-action/commit/5a334a8573fc27451af5b2a6ee175d8e11579e10))

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

CONTRIBUTING.md

@@ -18,7 +18,7 @@ Include the relevant issue number if applicable.
 
 ## Do you intend to add a new feature or change an existing one
 
-* Suggest your change by [opening a 'Feature request' issue][5] and start writing code (following the [developers guide](DEVELOPERS.md))
+* Suggest your change by [opening a 'Feature request' issue][5]
 
 ## Do you have questions about the source code
 

DEVELOPERS.md

@@ -1,38 +0,0 @@
-# Developers guide
-
-## Prepare
-
-Install the dependencies
-
-```bash
-npm install
-```
-
-## Develop
-
-Build the typescript and package it for distribution
-
-```bash
-npm run build && npm run package
-```
-
-Run the tests
-
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-
-...
-```
-
-## Contribute
-
-Before creating a commit, validate your changes and build the associated distribution files
-
-```bash
-npm run all
-```

README.md

@@ -1,202 +1,128 @@
-# GitHub Slug action
+# GitHub Slug Action
 
-This GitHub Action will expose the slug/short values of [some GitHub environment variables][default-environment-variables] inside your GitHub workflow.
+This GitHub Action exposes slug and short values of [GitHub environment variables][default-environment-variables] inside your workflow.
 
-## Table of Contents
-
-- [GitHub Slug action](#github-slug-action)
-  - [Table of Contents](#table-of-contents)
-  - [Overview](#overview)
-  - [Use this action](#use-this-action)
-  - [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)
-  - [Contribute](#contribute)
-  - [Troubleshooting](#troubleshooting)
-    - [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
-
-- put the variable content in lower case
-- replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
-- remove leading `-` characters
-- limit the string size to 63 characters
-- remove trailing `-` characters
-
-<details>
-  <summary>Others <b>Slug-ish</b> commands are available</summary>
-  <p>
-
-- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL
-  - Like `SLUG` but `.` is also replaced by `-`
-- `SHORT` on a variable will limit the string size to 8 characters
-  - 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
-  - Like `GITHUB_REF_SLUG_CS`
-
-  </p>
-</details>
-
-Additional enhanced environment variables can be compute to help you around GitHub environment variables.
-
-## Use this action
-
-Add this in your workflow
+## Quick Start
 
 ```yaml
-- name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v3.x
+steps:
+  - uses: actions/checkout@v6
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
 ```
 
-Check for more [examples][examples] (OS usage, URL use, ...)
+> [!CAUTION]
+> Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows.
 
-**Tip:** Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows.
+## What It Does
 
-## Available Environment variables
+- **SLUG** -- Lowercase, replace special characters with `-`, limit to 63 characters. _Dots and underscores preserved._
+- **SLUG_URL** -- Same as SLUG, but dots and underscores are also replaced. _Safe for URLs and subdomains._
+- **SHORT** -- Shorten Git SHA values to a unique prefix.
+- **PART** -- Extract portions of a variable (e.g., owner or repository name from `GITHUB_REPOSITORY`).
+- **_CS** -- Case-sensitive variants of SLUG and SLUG_URL (original casing preserved).
 
-**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]
+> Read the [slug transformation rules](docs/explanation/slug-transformation-rules.md) for the full algorithm and rationale.
 
-### Enhanced variables
+## Inputs
 
-- `GITHUB_REF_NAME` will contains 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.
+| Input | Default | Description |
+| ----- | ------- | ----------- |
+| `prefix` | `""` | Value prepended to each generated variable name |
+| `slug-maxlength` | `63` | Max length of slugified values (`"nolimit"` to disable) |
+| `short-length` | _(Git default)_ | Length of short SHA values (minimum `4`) |
 
-**NOTE:** All enhanced variables are available in all **slug** formats.
+See the [inputs reference](docs/reference/inputs.md) for details.
 
-### Partial variables
+## Available 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 | Type | Description |
+| -------- | ---- | ----------- |
+| [GITHUB_REF_POINT](docs/reference/variables.md#github_ref_point) | Enhanced | Branch or tag name (consistent across event types) |
+| [GITHUB_REPOSITORY_OWNER_PART](docs/reference/variables.md#github_repository_owner_part) | Partial | Owner extracted from repository |
+| [GITHUB_REPOSITORY_NAME_PART](docs/reference/variables.md#github_repository_name_part) | Partial | Repository name extracted from repository |
+| [GITHUB_REPOSITORY_SLUG](docs/reference/variables.md#github_repository_slug) | Slug | The owner and repository name |
+| [GITHUB_REF_SLUG](docs/reference/variables.md#github_ref_slug) | Slug | The branch or tag ref |
+| [GITHUB_REF_NAME_SLUG](docs/reference/variables.md#github_ref_name_slug) | Slug | The branch or tag name shown on GitHub |
+| [GITHUB_HEAD_REF_SLUG](docs/reference/variables.md#github_head_ref_slug) | Slug | PR head branch |
+| [GITHUB_BASE_REF_SLUG](docs/reference/variables.md#github_base_ref_slug) | Slug | PR base branch |
+| [GITHUB_EVENT_REF_SLUG](docs/reference/variables.md#github_event_ref_slug) | Slug | Webhook Git ref |
+| [GITHUB_SHA_SHORT](docs/reference/variables.md#github_sha_short) | Short | Shortened commit SHA |
+| [GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT](docs/reference/variables.md#github_event_pull_request_head_sha_short) | Short | Shortened PR head commit SHA |
 
-### Slug variables
+All slug variables also have `_SLUG_URL` and `_CS` variants. See the [full variable reference](docs/reference/variables.md).
 
-**NOTE:** `_CS` suffix available
+> [!TIP]
+> If you don't find what you need, read about [available GitHub variables](docs/reference/github-variables.md), [propose a new variable][custom-variable], or use [slugify-value][slugify-value] / [shortify-git-revision][shortify-git-revision] directly.
 
-| 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>          |
+## Documentation
 
-### Slug URL variables
+### Tutorial
 
-**NOTE:** `_CS` suffix available
+- [Getting started](docs/getting-started.md) -- Step-by-step guide for first-time users
 
-| 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>           |
+### How-To Guides
 
-### Short variables
+- [Use a prefix](docs/how-to/use-prefix.md)
+- [Configure slug max length](docs/how-to/configure-slug-maxlength.md)
+- [Configure short SHA length](docs/how-to/configure-short-length.md)
+- [Use slug variables in URLs](docs/how-to/use-slugs-in-urls.md)
+- More [workflow examples](https://github.com/rlespinasse/github-slug-action/tree/v5.x/examples) (OS-specific usage, URL patterns)
 
-| 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> |
+### Reference
 
-## Contribute
+- [Variable reference](docs/reference/variables.md) -- All variables with transformation examples
+- [Inputs reference](docs/reference/inputs.md) -- Action inputs specification
+- [GitHub variables by event](docs/reference/github-variables.md) -- Which variables are available per event type
 
-Follow [Developers guide](DEVELOPERS.md)
+### Explanation
+
+- [Slug transformation rules](docs/explanation/slug-transformation-rules.md) -- How and why transformations work
+
+## Migration
+
+- [Migrate from v4 to v5](docs/how-to/migrate-v4-to-v5.md) -- `GITHUB_REF_NAME` behaviour changed on pull request events
+- [Migrate from v3 to v4](docs/how-to/migrate-v3-to-v4.md) -- Short SHA length is now determined by Git
 
 ## Troubleshooting
 
-### 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.**
-
-If a variable start to be used as default environment variable, the environment variable may have a different behavior 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.
-
-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.
-
-**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 available in `v4` version
-
-```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.
-
-### An action could not be found at the URI
-
-If your workflow fail on the `Set up job` task with this kind of log :
-
-```text
-Download action repository 'rlespinasse/github-slug-action@master'
-##[error]An action could not be found at the URI 'https://api.github.com/repos/rlespinasse/github-slug-action/tarball/master'
-```
-
-> The master branch doesn't exists anymore.
->
-> The master branch EOL has been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][issue-15])
-
-Please, use the current branch `v3.x` or a version tag (see [releases pages][releases]) in order to fix your workflow.
+See the [troubleshooting guide](docs/how-to/troubleshooting.md) for common issues and solutions.
 
 ## Thanks for talking about us
 
-- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1] (in french :fr:)
-- [Github Actions : enfin des pipelines accessibles aux développeurs][talk-1] (in french :fr:)
+In English :gb:
+
 - [Action spotlight by Michael Heap][article-2]
-- The next one is you. _Don't hesitate to add youself to this list._
+- [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]
+- [Celebrating 5 Years of github-slug-action on sfeir.dev][article-7]
+
+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._
 
-[actions]: https://github.com/rlespinasse/github-slug-action/actions
-[license]: https://github.com/rlespinasse/github-slug-action/blob/v3.x/LICENSE
-[examples]: https://github.com/rlespinasse/github-slug-action/tree/v3.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
 
-[default-environment-variables]: https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
+[slugify-value]: https://github.com/rlespinasse/slugify-value
+[shortify-git-revision]: https://github.com/rlespinasse/shortify-git-revision
+
+[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
 
 [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/
-[talk-1]: https://www.youtube.com/watch?v=RHnTJBwcE98
+[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,23 +2,26 @@
 
 ## Supported Versions and Branches
 
-| Version | Branch | Supported          |
-|---------|--------|--------------------|
-| 3.x     | v3.x   | :white_check_mark: |
-| 2.x     | v2.x   | :white_check_mark: |
-| 1.1.x   | v1.1.x | :x:                |
-| < 1.x   |        | :x:                |
+| 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         |
 
-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
+
+Since `2023-10-20`, when a new major version is released,
+
+- 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.

__tests__/partial.test.ts

@@ -1,28 +0,0 @@
-import {sep} from 'path'
-import {get_first_part, get_second_part} from '../src/partial'
-
-function test_get_first_part(
-  input: string,
-  separator: string,
-  expected: string
-) {
-  let actual = get_first_part(input, separator)
-  expect(actual).toEqual(expected)
-}
-
-function test_get_second_part(
-  input: string,
-  separator: string,
-  expected: string
-) {
-  let actual = get_second_part(input, separator)
-  expect(actual).toEqual(expected)
-}
-
-test('get_first_part', () => {
-  test_get_first_part('first/second', '/', 'first')
-})
-
-test('get_second_part', () => {
-  test_get_second_part('first/second', '/', 'second')
-})

__tests__/shortsha.test.ts

@@ -1,10 +0,0 @@
-import {shortsha} from '../src/short'
-
-function test_short_sha(input: string, expected: string) {
-  let actual = shortsha(input)
-  expect(actual).toEqual(expected)
-}
-
-test('short_sha: long hash', () => {
-  test_short_sha('a35a1a486a260cfd99c5b6f8c6034a2929ba9b3f', 'a35a1a48')
-})

__tests__/slug.test.ts

@@ -1,73 +0,0 @@
-import {slug, slug_cs} from '../src/slug'
-
-function test_slug(input: string, expected: string) {
-  let actual = slug(input)
-  expect(actual).toEqual(expected)
-}
-
-function test_slug_cs(input: string, expected: string) {
-  let actual = slug_cs(input)
-  expect(actual).toEqual(expected)
-}
-
-test('slug: a word', () => {
-  test_slug('word', 'word')
-  test_slug_cs('word', 'word')
-})
-
-test('slug: a string', () => {
-  test_slug('basic-string', 'basic-string')
-  test_slug_cs('basic-string', 'basic-string')
-})
-
-test('slug: a string in camel case', () => {
-  test_slug('camelCase', 'camelcase')
-  test_slug_cs('camelCase', 'camelCase')
-})
-
-test('slug: a path', () => {
-  test_slug('path/to/something', 'path-to-something')
-  test_slug_cs('path/to/something', 'path-to-something')
-})
-
-test('slug: a number', () => {
-  test_slug('4.2', '4.2')
-  test_slug_cs('4.2', '4.2')
-})
-
-test('slug: an underscore', () => {
-  test_slug('An_Underscore', 'an_underscore')
-  test_slug_cs('An_Underscore', 'An_Underscore')
-})
-
-test('slug: special character', () => {
-  test_slug('feat-(!è§-character', 'feat------character')
-  test_slug_cs('feat-(!è§-character', 'feat------character')
-})
-
-test('slug: trailing', () => {
-  test_slug('-feat-trailing-', 'feat-trailing')
-  test_slug_cs('-feat-trailing-', 'feat-trailing')
-})
-
-test('slug: a very long string', () => {
-  test_slug(
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
-  )
-  test_slug_cs(
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
-  )
-})
-
-test('slug: short string after trailing', () => {
-  test_slug(
-    '-has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters-',
-    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
-  )
-  test_slug_cs(
-    '-has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters-',
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
-  )
-})

__tests__/slugref.test.ts

@@ -1,72 +0,0 @@
-import {slugref, slugref_cs} from '../src/slug'
-
-function test_slugref(input: string, expected: string) {
-  let actual = slugref(input)
-  expect(actual).toEqual(expected)
-}
-
-function test_slugref_cs(input: string, expected: string) {
-  let actual = slugref_cs(input)
-  expect(actual).toEqual(expected)
-}
-
-test('slug_ref:: master branch', () => {
-  test_slugref('refs/heads/master', 'master')
-  test_slugref_cs('refs/heads/master', 'master')
-})
-
-test('slug_ref: a feature branch', () => {
-  test_slugref('refs/heads/feat/new_feature', 'feat-new_feature')
-  test_slugref_cs('refs/heads/feat/new_feature', 'feat-new_feature')
-})
-
-test('slug_ref: a fix branch', () => {
-  test_slugref('refs/heads/fix/issue_number', 'fix-issue_number')
-  test_slugref_cs('refs/heads/fix/issue_number', 'fix-issue_number')
-})
-
-test('slug_ref: an underscore', () => {
-  test_slugref('refs/heads/An_Underscore', 'an_underscore')
-  test_slugref_cs('refs/heads/An_Underscore', 'An_Underscore')
-})
-
-test('slug_ref: a simple tag', () => {
-  test_slugref('refs/tags/v1.0.0', 'v1.0.0')
-  test_slugref_cs('refs/tags/v1.0.0', 'v1.0.0')
-})
-
-test('slug_ref: a complex tag', () => {
-  test_slugref('refs/tags/product@1.0.0-rc.2', 'product-1.0.0-rc.2')
-  test_slugref_cs('refs/tags/product@1.0.0-rc.2', 'product-1.0.0-rc.2')
-})
-
-test('slug_ref: a reference with upper case letters', () => {
-  test_slugref('refs/heads/New_Awesome_Product', 'new_awesome_product')
-  test_slugref_cs('refs/heads/New_Awesome_Product', 'New_Awesome_Product')
-})
-
-test('slug_ref: test trailing', () => {
-  test_slugref('refs/heads/-trailing-feat-', 'trailing-feat')
-  test_slugref_cs('refs/heads/-trailing-feat-', 'trailing-feat')
-})
-
-test('slug_ref: test refs inside string', () => {
-  test_slugref('refs/heads/-refs/tags/feature/-', 'refs-tags-feature')
-  test_slugref_cs('refs/heads/-refs/tags/feature/-', 'refs-tags-feature')
-})
-
-test('slug_ref: a very long name', () => {
-  test_slugref(
-    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
-  )
-  test_slugref_cs(
-    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
-  )
-})
-
-test('slug_ref: on pull-request ref', () => {
-  test_slugref('refs/pull/branch', 'branch')
-  test_slugref_cs('refs/pull/branch', 'branch')
-})

__tests__/slugurl.test.ts

@@ -1,57 +0,0 @@
-import {slugurl, slugurl_cs} from '../src/slug'
-
-function test_slugurl(input: string, expected: string) {
-  let actual = slugurl(input)
-  expect(actual).toEqual(expected)
-}
-
-function test_slugurl_cs(input: string, expected: string) {
-  let actual = slugurl_cs(input)
-  expect(actual).toEqual(expected)
-}
-
-test('slug_url: a word', () => {
-  test_slugurl('word', 'word')
-  test_slugurl_cs('word', 'word')
-})
-
-test('slug_url: a string', () => {
-  test_slugurl('basic-string', 'basic-string')
-  test_slugurl_cs('basic-string', 'basic-string')
-})
-
-test('slug_url: a string in camel case', () => {
-  test_slugurl('camelCase', 'camelcase')
-  test_slugurl_cs('camelCase', 'camelCase')
-})
-
-test('slug_url: a path', () => {
-  test_slugurl('path/to/something', 'path-to-something')
-  test_slugurl_cs('path/to/something', 'path-to-something')
-})
-
-test('slug_url: a number', () => {
-  test_slugurl('4.2', '4-2')
-  test_slugurl_cs('4.2', '4-2')
-})
-
-test('slug_url: an underscore', () => {
-  test_slugurl('An_Underscore', 'an-underscore')
-  test_slugurl_cs('An_Underscore', 'An-Underscore')
-})
-
-test('slug_url: trailing', () => {
-  test_slugurl('.path.to.', 'path-to')
-  test_slugurl_cs('.path.to.', 'path-to')
-})
-
-test('slug_url: a very long string', () => {
-  test_slugurl(
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
-  )
-  test_slugurl_cs(
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
-  )
-})

__tests__/slugurlref.test.ts

@@ -1,72 +0,0 @@
-import {slugurlref, slugurlref_cs} from '../src/slug'
-
-function test_slugurlref(input: string, expected: string) {
-  let actual = slugurlref(input)
-  expect(actual).toEqual(expected)
-}
-
-function test_slugurlref_cs(input: string, expected: string) {
-  let actual = slugurlref_cs(input)
-  expect(actual).toEqual(expected)
-}
-
-test('slug_url_ref: master branch', () => {
-  test_slugurlref('refs/heads/master', 'master')
-  test_slugurlref_cs('refs/heads/master', 'master')
-})
-
-test('slug_url_ref: a feature branch', () => {
-  test_slugurlref('refs/heads/feat/new_feature', 'feat-new-feature')
-  test_slugurlref_cs('refs/heads/feat/new_feature', 'feat-new-feature')
-})
-
-test('slug_url_ref: a fix branch', () => {
-  test_slugurlref('refs/heads/fix/issue_number', 'fix-issue-number')
-  test_slugurlref_cs('refs/heads/fix/issue_number', 'fix-issue-number')
-})
-
-test('slug_url_ref: an underscore', () => {
-  test_slugurlref('refs/heads/An_Underscore', 'an-underscore')
-  test_slugurlref_cs('refs/heads/An_Underscore', 'An-Underscore')
-})
-
-test('slug_url_ref: a simple tag', () => {
-  test_slugurlref('refs/tags/v1.0.0', 'v1-0-0')
-  test_slugurlref_cs('refs/tags/v1.0.0', 'v1-0-0')
-})
-
-test('slug_url_ref: a complex tag', () => {
-  test_slugurlref('refs/tags/product@1.0.0-rc.2', 'product-1-0-0-rc-2')
-  test_slugurlref_cs('refs/tags/product@1.0.0-rc.2', 'product-1-0-0-rc-2')
-})
-
-test('slug_url_ref: a reference with upper case letters', () => {
-  test_slugurlref('refs/heads/New_Awesome_Product', 'new-awesome-product')
-  test_slugurlref_cs('refs/heads/New_Awesome_Product', 'New-Awesome-Product')
-})
-
-test('slug_url_ref: a very long name', () => {
-  test_slugurlref(
-    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
-  )
-  test_slugurlref_cs(
-    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
-  )
-})
-
-test('slug_url_ref: test trailing', () => {
-  test_slugurlref('refs/heads/-an-awesome-Feature-', 'an-awesome-feature')
-  test_slugurlref_cs('refs/heads/-an-awesome-Feature-', 'an-awesome-Feature')
-})
-
-test('slug_url_ref: test trailing with dot', () => {
-  test_slugurlref('refs/heads/.an-awesome-Feature.', 'an-awesome-feature')
-  test_slugurlref_cs('refs/heads/.an-awesome-Feature.', 'an-awesome-Feature')
-})
-
-test('slug_url_ref: on pull-request ref', () => {
-  test_slugurlref('refs/pull/branch', 'branch')
-  test_slugurlref_cs('refs/pull/branch', 'branch')
-})

action.yml

@@ -1,9 +1,120 @@
-name: 'GitHub Slug Action'
-description: 'GitHub Action to expose slug value of environment variables inside your GitHub workflow'
-author: 'rlespinasse'
-runs:
-  using: 'node20'
-  main: 'dist/index.js'
+name: "GitHub Slug Action"
+description: "GitHub Action to expose slug value of environment variables inside your GitHub workflow"
+author: "Romain Lespinasse"
 branding:
-  icon: 'minimize'
-  color: 'blue'
+  icon: "minimize"
+  color: "blue"
+inputs:
+  prefix:
+    description: "Value to prepend to each generated variable"
+    default: ""
+    required: false
+  slug-maxlength:
+    description: "Max length of the slugified values"
+    default: "63"
+    required: true
+  short-length:
+    description: "Length of the shortify values (git default if empty)"
+    required: false
+runs:
+  using: "composite"
+  steps:
+    - run: $GITHUB_ACTION_PATH/preflight.sh
+      id: prefligth
+      shell: bash
+      env:
+        INPUT_SLUG_MAXLENGTH: ${{ inputs.slug-maxlength }}
+        INPUT_SHORT_LENGTH: ${{ inputs.short-length }}
+
+    # From Environment Variables
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # v1.4.0
+      with:
+        key: GITHUB_REPOSITORY
+        value: ${{ github.repository }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # v1.4.0
+      with:
+        key: GITHUB_REF
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # v1.4.0
+      with:
+        key: GITHUB_HEAD_REF
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # v1.4.0
+      with:
+        key: GITHUB_BASE_REF
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+
+    # From Specific values
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # v1.4.0
+      with:
+        key: GITHUB_EVENT_REF
+        value: ${{ github.event.ref }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # v1.4.0
+      with:
+        key: GITHUB_REF_NAME
+        value: ${{ github.ref_name }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # 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 }}
+      env:
+        GITHUB_HEAD_REF_RAW: ${{ github.head_ref }}
+        GITHUB_REF_NAME_RAW: ${{ github.ref_name }}
+
+    # From Calculated values
+    - id: get-github-repository-owner-part
+      run: |
+        ownerpart=$(echo $GITHUB_REPOSITORY | cut -d/ -f1)
+        if [ -f "$GITHUB_OUTPUT" ]; then
+          echo "github-repository-owner-part=${ownerpart}" >> "$GITHUB_OUTPUT"
+        else
+          echo "::set-output name=github-repository-owner-part::${ownerpart}"
+        fi
+      shell: bash
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # v1.4.0
+      with:
+        key: GITHUB_REPOSITORY_OWNER_PART
+        value: ${{ steps.get-github-repository-owner-part.outputs.github-repository-owner-part }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - id: get-github-repository-name-part
+      run: |
+        namepart=$(echo $GITHUB_REPOSITORY | cut -d/ -f2)
+        if [ -f "$GITHUB_OUTPUT" ]; then
+          echo "github-repository-name-part=${namepart}" >> "$GITHUB_OUTPUT"
+        else
+          echo "::set-output name=github-repository-name-part::${namepart}"
+        fi
+      shell: bash
+    - uses: rlespinasse/slugify-value@a4879db1eb3db9bbee01dca36f98a8236c2b8239 # v1.4.0
+      with:
+        key: GITHUB_REPOSITORY_NAME_PART
+        value: ${{ steps.get-github-repository-name-part.outputs.github-repository-name-part }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+
+    # From sha
+    - uses: rlespinasse/shortify-git-revision@c90ba7007ef6c152254d10b9f1a327966ab13077 # v1.6.0
+      with:
+        name: GITHUB_SHA
+        short-on-error: true
+        length: ${{ steps.prefligth.outputs.PREFLIGHT_SHORT_LENGTH }}
+        prefix: ${{ inputs.prefix }}
+    - uses: rlespinasse/shortify-git-revision@c90ba7007ef6c152254d10b9f1a327966ab13077 # v1.6.0
+      with:
+        name: GITHUB_EVENT_PULL_REQUEST_HEAD_SHA
+        revision: ${{ github.event.pull_request.head.sha }}
+        short-on-error: true
+        length: ${{ steps.prefligth.outputs.PREFLIGHT_SHORT_LENGTH }}
+        prefix: ${{ inputs.prefix }}

docs/explanation/slug-transformation-rules.md

@@ -0,0 +1,89 @@
+# Slug Transformation Rules
+
+This page explains the transformation algorithms used by the GitHub Slug Action, why they exist, and how they differ from each other.
+
+## What is a "slug"?
+
+A slug is a human-readable identifier derived from a string, safe for use in URLs, filenames, DNS labels, and other contexts where special characters are problematic. The term originates from publishing, where a "slug" is a short label used to identify a piece of content.
+
+In CI/CD workflows, branch names, tag names, and repository names often contain characters (`/`, `@`, spaces) that break when used in URLs, Docker tags, Kubernetes labels, or file paths. Slugifying these values makes them safe for such contexts.
+
+## SLUG transformation
+
+The `SLUG` transformation applies the following steps in order:
+
+1. **Lowercase** the entire string
+2. **Replace** any character that is not `0-9`, `a-z`, `.`, or `_` with `-`
+3. **Remove** leading `-` characters
+4. **Truncate** to a maximum length (default: 63 characters)
+5. **Remove** trailing `-` characters
+
+### SLUG examples
+
+| Input | Output |
+| ----- | ------ |
+| `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` |
+| `octocat/Hello-World` | `octocat-hello-world` |
+
+Note that `.` and `_` are preserved in SLUG output.
+
+## SLUG_URL transformation
+
+The `SLUG_URL` transformation is identical to `SLUG` except that `.` and `_` are also replaced with `-` in step 2. This makes the result safe for use as a URL path segment or subdomain label, where dots and underscores can cause issues.
+
+### SLUG_URL examples
+
+| Input | SLUG | SLUG_URL |
+| ----- | ---- | -------- |
+| `refs/tags/v1.0.0` | `v1.0.0` | `v1-0-0` |
+| `rlespinasse/Hello-World.go` | `rlespinasse-hello-world.go` | `rlespinasse-hello-world-go` |
+| `refs/heads/feat/new_feature` | `feat-new-feature` | `feat-new-feature` |
+
+### When to use which
+
+- Use **SLUG** for Docker tags, file paths, and general identifiers (dots and underscores are allowed)
+- Use **SLUG_URL** for subdomains, URL path segments, and any context where dots or underscores are problematic
+
+## Why 63 characters?
+
+The default maximum length of 63 comes from the [DNS label length limit](https://www.rfc-editor.org/rfc/rfc1035#section-2.3.4). This is also the maximum length for:
+
+- Kubernetes resource labels
+- Many cloud provider resource names
+- DNS subdomain components
+
+You can change this limit with the `slug-maxlength` input, or set it to `"nolimit"` to disable truncation entirely.
+
+## SHORT transformation
+
+The `SHORT` transformation truncates Git commit SHAs to a shorter, still-unique prefix. By default, Git determines the optimal length based on your repository size using [`git rev-parse --short`][git-revparse].
+
+| Input | Output |
+| ----- | ------ |
+| `ffac537e6cbbf934b08745a378932722df287a53` | `ffac537e` |
+
+The length varies by repository because larger repositories need longer prefixes to avoid collisions. You can set a fixed length with the `short-length` input (minimum: 4).
+
+## Case-sensitive variants (_CS)
+
+Every `SLUG` and `SLUG_URL` variable also has a `_CS` (case-sensitive) variant that skips the lowercase step. For example:
+
+| Input | SLUG | SLUG_CS |
+| ----- | ---- | ------- |
+| `refs/heads/New_Awesome_Product` | `new-awesome-product` | `New-Awesome-Product` |
+
+This is useful when the original casing carries meaning (e.g., product names).
+
+## PART extraction
+
+The `PART` transformation splits a composite value and extracts a portion. Currently used for `GITHUB_REPOSITORY`:
+
+| Input | OWNER_PART | NAME_PART |
+| ----- | ---------- | --------- |
+| `octocat/Hello-World` | `octocat` | `Hello-World` |
+
+PART variables preserve the original casing. They can be further transformed using SLUG or SLUG_URL suffixes (e.g., `GITHUB_REPOSITORY_OWNER_PART_SLUG`).
+
+[git-revparse]: https://git-scm.com/docs/git-rev-parse#Documentation/git-rev-parse.txt---shortlength

docs/getting-started.md

@@ -0,0 +1,101 @@
+# Getting Started with GitHub Slug Action
+
+This tutorial walks you through adding the GitHub Slug Action to a workflow and using slug variables for the first time.
+
+## Prerequisites
+
+- A GitHub repository with [GitHub Actions enabled](https://docs.github.com/en/actions/using-workflows)
+
+## Step 1: Add the action to your workflow
+
+Create or edit a workflow file (e.g., `.github/workflows/deploy.yml`) and add the action after checking out your code:
+
+```yaml
+name: Deploy
+
+on: push
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Inject enhanced GitHub environment variables
+        uses: rlespinasse/github-slug-action@v5
+```
+
+> [!TIP]
+> The `actions/checkout` step is recommended so that Git can determine the optimal short SHA length for your repository. It is not strictly required for slug variables.
+
+## Step 2: Use slug variables in subsequent steps
+
+After the action runs, all slug variables are available as environment variables. Add a step to use them:
+
+```yaml
+      - name: Print slug variables
+        run: |
+          echo "Repository slug: $GITHUB_REPOSITORY_SLUG"
+          echo "Branch slug:     $GITHUB_REF_SLUG"
+          echo "Short SHA:       $GITHUB_SHA_SHORT"
+        shell: bash
+```
+
+For a branch named `feat/new_feature` on repository `octocat/Hello-World`, this outputs:
+
+```text
+Repository slug: octocat-hello-world
+Branch slug:     feat-new-feature
+Short SHA:       ffac537e
+```
+
+## Step 3: Use a slug variable for a practical purpose
+
+A common use case is naming deployment previews with a URL-safe branch identifier:
+
+```yaml
+      - name: Deploy preview
+        run: |
+          echo "Deploying to https://${GITHUB_REF_SLUG_URL}.preview.example.com"
+        shell: bash
+```
+
+The `SLUG_URL` variant replaces dots and underscores too, making it safe for subdomains.
+
+## Complete workflow
+
+Here is the full workflow file:
+
+```yaml
+name: Deploy
+
+on: push
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Inject enhanced GitHub environment variables
+        uses: rlespinasse/github-slug-action@v5
+
+      - name: Deploy preview
+        run: |
+          echo "Deploying to https://${GITHUB_REF_SLUG_URL}.preview.example.com"
+          echo "Commit: ${GITHUB_SHA_SHORT}"
+        shell: bash
+```
+
+## What you learned
+
+- **SLUG** variables convert values to lowercase and replace special characters with `-`
+- **SLUG_URL** variables also replace `.` and `_`, making values safe for URLs and subdomains
+- **SHORT** variables shorten SHA commit hashes
+- All variables are exposed as environment variables for use in subsequent steps
+
+## Next steps
+
+- [How-to guides](how-to/) for specific configuration tasks (prefixes, custom lengths, URL usage)
+- [Variable reference](reference/variables.md) for the complete list of available variables
+- [Slug transformation rules](explanation/slug-transformation-rules.md) to understand how transformations work

docs/github-variables.md

@@ -1,96 +1,3 @@
 # Available GitHub Variables
 
-All `GitHub` variables availables in your workflow in addition of ones exposed by this Action
-
-## Table of Contents
-
-- [Available GitHub Variables](#available-github-variables)
-  - [Table of Contents](#table-of-contents)
-  - [Default environment variables](#default-environment-variables)
-    - [Action-managed Environment Variables](#action-managed-environment-variables)
-  - [Variables from events](#variables-from-events)
-    - [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)
-
-## Default environment variables
-
-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`             |
-
-## Variables from events
-
-Read the official documentation about [Events that trigger workflows][2].
-
-### Action-managed Event Variables
-
-#### create
-
-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 |
-
-#### 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 |
-
-#### pull_request
-
-Checkout [pull_request][5] webhook payload content
-
-| 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                             |
-| ---------------------------------- | ---------------------------------------- |
-| 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                             |
-| ---------------------------------- | ---------------------------------------- |
-| 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                             |
-| ---------------------------------- | ---------------------------------------- |
-| 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
-[2]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
-[3]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#create
-[4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#delete
-[5]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request
-[6]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review
-[7]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review_comment
+This page has moved to [reference/github-variables.md](reference/github-variables.md).

docs/how-to/configure-short-length.md

@@ -0,0 +1,45 @@
+# Configure the length of short SHA values
+
+Set a specific length for shortened commit SHA values instead of letting Git determine it automatically.
+
+## Usage
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+    with:
+      short-length: 7
+```
+
+## Common values
+
+| Value | Use case |
+| ----- | -------- |
+| _(empty)_ | Let Git decide based on repository size (default) |
+| `7` | Common "small repository" length |
+| `8` | Reproduce `v3` action behaviour |
+| `4` | Minimum allowed length |
+
+## Letting Git decide (default)
+
+When `short-length` is left empty, the action uses Git's [`git rev-parse --short`][git-revparse] behaviour. The length depends on the size of your repository and may change over time as the repository grows.
+
+> [!WARNING]
+> If you leave `short-length` empty, you need to checkout the source first so Git can determine the length:
+>
+> ```yaml
+> steps:
+>   - uses: actions/checkout@v6
+>   - uses: rlespinasse/github-slug-action@v5
+> ```
+>
+> Without a checkout step, the action falls back to the effective value of the [`core.abbrev`][git-core-abbrev] Git configuration variable, or `7` if unavailable.
+
+## See also
+
+- [Inputs reference](../reference/inputs.md) for the full specification
+- [SHORT transformation](../explanation/slug-transformation-rules.md#short-transformation) for how short values are computed
+
+[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

docs/how-to/configure-slug-maxlength.md

@@ -0,0 +1,33 @@
+# Configure the maximum length for slug values
+
+Change the maximum length of slugified values. The default is 63 characters (the DNS label length limit).
+
+## Usage
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+    with:
+      slug-maxlength: 80
+```
+
+## Disable the length limit
+
+Set `slug-maxlength` to `"nolimit"` to disable truncation entirely:
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+    with:
+      slug-maxlength: nolimit
+```
+
+> [!WARNING]
+> The `slug-maxlength` input must not be empty. If left empty, the action will fail during preflight validation.
+
+## See also
+
+- [Inputs reference](../reference/inputs.md) for the full specification
+- [Why 63 characters?](../explanation/slug-transformation-rules.md#why-63-characters) for the rationale behind the default

docs/how-to/migrate-v3-to-v4.md

@@ -0,0 +1,30 @@
+# Migrate from v3 to v4
+
+The main breaking change in v4 is that **short SHA length** is now determined by Git instead of being fixed at 8 characters.
+
+## What changed
+
+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 change over time as the repository grows.
+
+## How to migrate
+
+To reproduce the previous fixed-length behaviour, set `short-length` to `8`:
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+    with:
+      short-length: 8 # Same as v3 and before
+```
+
+Other options:
+
+- Set `7` to reproduce small repository behaviour
+- Leave empty to let Git decide (recommended)
+
+> [!WARNING]
+> The minimum length is `4`. The default is the effective value of the [`core.abbrev`][git-core-abbrev] Git configuration variable.
+
+[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

docs/how-to/migrate-v4-to-v5.md

@@ -0,0 +1,30 @@
+# Migrate from v4 to v5
+
+The main breaking change in v5 is that **GITHUB_REF_NAME** slug variables now match GitHub's native behaviour on `pull_request*` events.
+
+## What changed
+
+Before v5, the action overrode `GITHUB_REF_NAME` to always contain the branch name, even on pull request events. Starting with v5, `GITHUB_REF_NAME` on pull request events contains `<PR-number>/merge` (matching GitHub's native behaviour). Read the [full story][issue-104].
+
+## How to migrate
+
+If you used `GITHUB_REF_NAME_SLUG` to get the branch name on pull request events, switch to `GITHUB_REF_POINT_SLUG`:
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+  - run: |
+      echo "Branch Name: ${GITHUB_REF_POINT}"
+    shell: bash
+```
+
+`GITHUB_REF_POINT` provides the branch name on pull request events (via `GITHUB_HEAD_REF`) and the ref name on all other events (via `GITHUB_REF_NAME`). All slug suffixes are available: `GITHUB_REF_POINT_SLUG`, `GITHUB_REF_POINT_SLUG_URL`, etc.
+
+## Expression syntax
+
+- `${{ env.GITHUB_REF_POINT }}` and `$GITHUB_REF_POINT` both serve the action's behaviour
+- `${{ env.GITHUB_REF_NAME }}` serves the action's behaviour
+- `$GITHUB_REF_NAME` serves GitHub Action's native behaviour
+
+[issue-104]: https://github.com/rlespinasse/github-slug-action/issues/104

docs/how-to/troubleshooting.md

@@ -0,0 +1,56 @@
+# Troubleshooting
+
+## One of the environment variables doesn't work as intended
+
+> [!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 starts to be used as a default environment variable by GitHub, the behaviour may differ depending on how you reference it:
+
+- `${{ env.GITHUB_AWESOME_VARIABLE }}` serves the behaviour of this action
+- `$GITHUB_AWESOME_VARIABLE` serves the behaviour of GitHub Actions
+
+If both expressions return the same value, the variable is not affected. Use the [`prefix` input](use-prefix.md) to avoid this issue entirely.
+
+> [!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 fails on the `Set up job` task with this kind of log:
+
+```text
+Download action repository 'rlespinasse/github-slug-action@GIT_REFERENCE'
+##[error]An action could not be found at the URI 'https://api.github.com/repos/rlespinasse/github-slug-action/tarball/GIT_REFERENCE'
+```
+
+If the `GIT_REFERENCE` value is:
+
+- `v4.x` or after: following the [end-of-life for a branch](../../SECURITY.md#end-of-life-of-a-branch) security process, this branch may have been deleted.
+- `master`: this branch no longer exists. Read more on the corresponding issue ([EOL issue][issue-15]).
+
+Use the current **major tag** `v5` or a specific version tag (see [releases][releases]) to fix your workflow.
+
+## Short variables are empty or have unexpected length
+
+If `GITHUB_SHA_SHORT` is empty or shorter than expected, ensure you have checked out your repository before the action runs:
+
+```yaml
+steps:
+  - uses: actions/checkout@v6
+  - uses: rlespinasse/github-slug-action@v5
+```
+
+Without a checkout, Git cannot determine the optimal short length for your repository. Alternatively, set a fixed `short-length` to avoid depending on the checkout:
+
+```yaml
+steps:
+  - uses: rlespinasse/github-slug-action@v5
+    with:
+      short-length: 7
+```
+
+[naming-conventions]: https://docs.github.com/en/actions/reference/workflows-and-actions/variables#naming-conventions-for-configuration-variables
+[default-environment-variables]: https://docs.github.com/en/actions/reference/workflows-and-actions/variables#default-environment-variables
+[issue-15]: https://github.com/rlespinasse/github-slug-action/issues/15
+[releases]: https://github.com/rlespinasse/github-slug-action/releases

docs/how-to/use-prefix.md

@@ -0,0 +1,26 @@
+# Use a prefix for generated variables
+
+Add a prefix to all generated environment variables to avoid naming conflicts with [GitHub's default environment variables](https://docs.github.com/en/actions/reference/workflows-and-actions/variables#default-environment-variables).
+
+## Usage
+
+```yaml
+steps:
+  - name: Inject enhanced GitHub environment variables
+    uses: rlespinasse/github-slug-action@v5
+    with:
+      prefix: CI_
+```
+
+With this configuration, variables are named `CI_GITHUB_REPOSITORY_SLUG`, `CI_GITHUB_REF_SLUG`, `CI_GITHUB_SHA_SHORT`, etc.
+
+## When to use a prefix
+
+- When a variable name collides with a GitHub default environment variable (the assignment would be silently ignored without a prefix)
+- When you want to distinguish slug variables from other environment variables in your workflow
+- As a preventive measure against future GitHub environment variable additions
+
+## See also
+
+- [Inputs reference](../reference/inputs.md) for the full `prefix` input specification
+- [Troubleshooting](troubleshooting.md#one-of-the-environment-variables-doesnt-work-as-intended) for details on variable name collisions

docs/how-to/use-slugs-in-urls.md

@@ -0,0 +1,36 @@
+# Use slug variables in URLs
+
+Use `SLUG_URL` variables (not `SLUG`) when building URLs, because `SLUG_URL` also replaces dots and underscores with hyphens, making values safe for subdomains and URL paths.
+
+## As a subdomain
+
+```yaml
+steps:
+  - uses: actions/checkout@v6
+  - uses: rlespinasse/github-slug-action@v5
+  - run: |
+      ./deploy-application.sh --url "https://${{ env.GITHUB_REF_SLUG_URL }}.staging.app.example.com"
+```
+
+For a branch `feat/new_feature`, this produces `https://feat-new-feature.staging.app.example.com`.
+
+## As a URL path segment
+
+```yaml
+steps:
+  - uses: actions/checkout@v6
+  - uses: rlespinasse/github-slug-action@v5
+  - run: |
+      ./deploy-application.sh --url "https://staging.app.example.com/${{ env.GITHUB_REF_SLUG_URL }}"
+```
+
+## Why SLUG_URL instead of SLUG?
+
+The `SLUG` transformation preserves `.` and `_` characters. In a subdomain like `v1.0.0.staging.example.com`, the dots from the version tag would create invalid DNS resolution. `SLUG_URL` replaces them: `v1-0-0.staging.example.com`.
+
+See [Slug transformation rules](../explanation/slug-transformation-rules.md#slug_url-transformation) for the full comparison.
+
+## See also
+
+- [Full example workflow](../../examples/url-use.yml)
+- [Variable reference](../reference/variables.md) for all available `SLUG_URL` variables

docs/partial-variables.md

@@ -1,28 +1,3 @@
 # Partial Variables
 
-## Table of Contents
-
-- [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
-
-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_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              |
+This page has moved to [reference/variables.md](reference/variables.md#partial-variables).

docs/reference/github-variables.md

@@ -0,0 +1,87 @@
+# Available GitHub Variables
+
+All GitHub variables available in your workflow in addition to ones exposed by this action.
+
+## Default Environment Variables
+
+Read the official documentation about [Default environment variables][1].
+
+### Action-managed Environment Variables
+
+| Action-managed Variables | Can be suffixed 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
+
+Read the official documentation about [Events that trigger workflows][2].
+
+### Action-managed Event Variables
+
+#### create
+
+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 |
+
+#### 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 |
+
+#### pull_request
+
+Checkout [pull_request][5] webhook payload content
+
+| 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 |
+| ------------------------ | ------------ |
+| 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 |
+| ------------------------ | ------------ |
+| 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 |
+| ------------------------ | ------------ |
+| github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
+
+## See also
+
+- [Variable reference](variables.md) for transformation examples
+- [Slug transformation rules](../explanation/slug-transformation-rules.md) for how transformations work
+
+[1]: https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables
+[2]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
+[3]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#create
+[4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#delete
+[5]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request
+[6]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review
+[7]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review_comment

docs/reference/inputs.md

@@ -0,0 +1,23 @@
+# Inputs Reference
+
+The GitHub Slug Action accepts the following inputs in the `with:` block.
+
+| Input | Required | Default | Description |
+| ----- | -------- | ------- | ----------- |
+| `prefix` | No | `""` | Value prepended to each generated variable name. For example, `prefix: CI_` produces `CI_GITHUB_REPOSITORY_SLUG` instead of `GITHUB_REPOSITORY_SLUG`. |
+| `slug-maxlength` | Yes | `63` | Maximum length of slugified values. Accepts a number or `"nolimit"` to disable truncation. Must not be empty. |
+| `short-length` | No | _(Git default)_ | Length of shortened SHA values. Minimum `4`. When empty, Git determines the length based on your repository size using [`git rev-parse`][git-revparse]. |
+
+## Notes
+
+- When `short-length` is left empty, the action uses the effective value of the [`core.abbrev`][git-core-abbrev] Git configuration variable. This requires your repository to be checked out first (via `actions/checkout`).
+- The `slug-maxlength` default of `63` matches the DNS label length limit, which is also the maximum length for Kubernetes labels.
+
+## See also
+
+- [How to use a prefix](../how-to/use-prefix.md)
+- [How to configure slug max length](../how-to/configure-slug-maxlength.md)
+- [How to configure short length](../how-to/configure-short-length.md)
+
+[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

docs/reference/variables.md

@@ -0,0 +1,312 @@
+# Variable Reference
+
+Complete reference for all environment variables generated by the GitHub Slug Action.
+
+> [!TIP]
+> All slug and slug-url variables are also available in case-sensitive (`_CS`) variants. See [Case-sensitive variants](#case-sensitive-variants).
+
+## Summary
+
+| Variable | Type | Description |
+| -------- | ---- | ----------- |
+| `GITHUB_REF_POINT` | Enhanced | Branch or tag name (consistent across event types) |
+| `GITHUB_REPOSITORY_OWNER_PART` | Partial | Owner extracted from `GITHUB_REPOSITORY` |
+| `GITHUB_REPOSITORY_NAME_PART` | Partial | Repository name extracted from `GITHUB_REPOSITORY` |
+| `GITHUB_REPOSITORY_SLUG` | Slug | Slugified owner/repository name |
+| `GITHUB_REPOSITORY_OWNER_PART_SLUG` | Slug | Slugified owner name |
+| `GITHUB_REPOSITORY_NAME_PART_SLUG` | Slug | Slugified repository name |
+| `GITHUB_REF_SLUG` | Slug | Slugified branch or tag ref |
+| `GITHUB_REF_NAME_SLUG` | Slug | Slugified branch or tag name |
+| `GITHUB_HEAD_REF_SLUG` | Slug | Slugified PR head branch |
+| `GITHUB_BASE_REF_SLUG` | Slug | Slugified PR base branch |
+| `GITHUB_EVENT_REF_SLUG` | Slug | Slugified webhook ref |
+| `GITHUB_REPOSITORY_SLUG_URL` | Slug URL | URL-safe owner/repository name |
+| `GITHUB_REPOSITORY_OWNER_PART_SLUG_URL` | Slug URL | URL-safe owner name |
+| `GITHUB_REPOSITORY_NAME_PART_SLUG_URL` | Slug URL | URL-safe repository name |
+| `GITHUB_REF_SLUG_URL` | Slug URL | URL-safe branch or tag ref |
+| `GITHUB_REF_NAME_SLUG_URL` | Slug URL | URL-safe branch or tag name |
+| `GITHUB_HEAD_REF_SLUG_URL` | Slug URL | URL-safe PR head branch |
+| `GITHUB_BASE_REF_SLUG_URL` | Slug URL | URL-safe PR base branch |
+| `GITHUB_EVENT_REF_SLUG_URL` | Slug URL | URL-safe webhook ref |
+| `GITHUB_SHA_SHORT` | Short | Shortened commit SHA |
+| `GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT` | Short | Shortened PR head commit SHA |
+
+---
+
+## Enhanced Variables
+
+### GITHUB_REF_POINT
+
+The reference name (branch or tag), consistent across all event types:
+
+- Uses `GITHUB_HEAD_REF` in [`pull_request*`][webhooks] event contexts
+- Uses `GITHUB_REF_NAME` in all other event contexts
+
+This provides a stable branch name regardless of event type. On pull request events, `GITHUB_REF_NAME` contains `<PR#>/merge`, while `GITHUB_REF_POINT` contains the actual branch name.
+
+Available with all slug suffixes: `GITHUB_REF_POINT_SLUG`, `GITHUB_REF_POINT_SLUG_URL`, `GITHUB_REF_POINT_SLUG_CS`, `GITHUB_REF_POINT_SLUG_URL_CS`.
+
+---
+
+## Partial Variables
+
+### 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_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 |
+
+---
+
+## Slug Variables
+
+Slug variables apply the [SLUG transformation](../explanation/slug-transformation-rules.md#slug-transformation): lowercase, replace special characters with `-`, preserve `.` and `_`, truncate to max length.
+
+### GITHUB_REPOSITORY_SLUG
+
+Slug of **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 |
+| AnotherPerson/SomeRepository | anotherperson-somerepository |
+
+### GITHUB_REPOSITORY_OWNER_PART_SLUG
+
+Slug of **GITHUB_REPOSITORY_OWNER_PART** -- the owner name.
+
+| GITHUB_REPOSITORY_OWNER_PART | GITHUB_REPOSITORY_OWNER_PART_SLUG |
+| ---------------------------- | --------------------------------- |
+| octocat | octocat |
+| rlespinasse | rlespinasse |
+| AnotherPerson | anotherperson |
+
+### GITHUB_REPOSITORY_NAME_PART_SLUG
+
+Slug of **GITHUB_REPOSITORY_NAME_PART** -- the repository name.
+
+| GITHUB_REPOSITORY_NAME_PART | GITHUB_REPOSITORY_NAME_PART_SLUG |
+| --------------------------- | -------------------------------- |
+| Hello-World | hello-world |
+| Hello-World.go | hello-world.go |
+| SomeRepository | somerepository |
+
+### GITHUB_REF_SLUG
+
+Slug of **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 |
+| refs/heads/New_Awesome_Product | new-awesome-product |
+
+### GITHUB_REF_NAME_SLUG
+
+Slug of **GITHUB_REF_NAME** -- the branch or tag name shown on GitHub.
+_If neither a branch or tag is available for the event type, the variable will not exist._
+
+| GITHUB_REF_NAME | GITHUB_REF_NAME_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 of **GITHUB_HEAD_REF** -- the branch of the head repository.
+_Only set for [`pull_request*`][webhooks] events and forked repositories._
+
+| GITHUB_HEAD_REF | GITHUB_HEAD_REF_SLUG |
+| --------------- | -------------------- |
+| main | main |
+| feat/new_feature | feat-new-feature |
+| New_Awesome_Product | new-awesome-product |
+
+### GITHUB_BASE_REF_SLUG
+
+Slug of **GITHUB_BASE_REF** -- the branch of the base repository.
+_Only set for [`pull_request*`][webhooks] events and forked repositories._
+
+| GITHUB_BASE_REF | GITHUB_BASE_REF_SLUG |
+| --------------- | -------------------- |
+| main | main |
+| feat/new_feature | feat-new-feature |
+| New_Awesome_Product | new-awesome-product |
+
+### GITHUB_EVENT_REF_SLUG
+
+Slug of **github.event.ref** -- the Git reference resource associated to the triggered webhook.
+_Only set for [`create` and `delete`][webhooks] events._
+
+| github.event.ref | GITHUB_EVENT_REF_SLUG |
+| ---------------- | --------------------- |
+| main | main |
+| feat/new_feature | feat-new-feature |
+| New_Awesome_Product | new-awesome-product |
+
+---
+
+## URL-Safe Slug Variables
+
+URL-safe slug variables apply the [SLUG_URL transformation](../explanation/slug-transformation-rules.md#slug_url-transformation): same as SLUG but `.` and `_` are also replaced with `-`.
+
+### GITHUB_REPOSITORY_SLUG_URL
+
+URL-safe slug of **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 |
+| AnotherPerson/SomeRepository | anotherperson-somerepository |
+
+### GITHUB_REPOSITORY_OWNER_PART_SLUG_URL
+
+URL-safe slug of **GITHUB_REPOSITORY_OWNER_PART** -- the owner name.
+
+| GITHUB_REPOSITORY_OWNER_PART | GITHUB_REPOSITORY_OWNER_PART_SLUG_URL |
+| ---------------------------- | ------------------------------------- |
+| octocat | octocat |
+| rlespinasse | rlespinasse |
+| AnotherPerson | anotherperson |
+
+### GITHUB_REPOSITORY_NAME_PART_SLUG_URL
+
+URL-safe slug of **GITHUB_REPOSITORY_NAME_PART** -- the repository name.
+
+| GITHUB_REPOSITORY_NAME_PART | GITHUB_REPOSITORY_NAME_PART_SLUG_URL |
+| --------------------------- | ------------------------------------ |
+| Hello-World | hello-world |
+| Hello-World.go | hello-world-go |
+| SomeRepository | somerepository |
+
+### GITHUB_REF_SLUG_URL
+
+URL-safe slug of **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 |
+| refs/heads/New_Awesome_Product | new-awesome-product |
+
+### GITHUB_REF_NAME_SLUG_URL
+
+URL-safe slug of **GITHUB_REF_NAME** -- the branch or tag name shown on GitHub.
+_If neither a branch or tag is available for the event type, the variable will not exist._
+
+| GITHUB_REF_NAME | GITHUB_REF_NAME_SLUG_URL |
+| --------------- | ------------------------ |
+| main | main |
+| feat/new_feature | feat-new-feature |
+| v1.0.0 | v1-0-0 |
+| 42/merge | 42-merge |
+| product@1.0.0-rc.2 | product-1-0-0-rc-2 |
+| New_Awesome_Product | new-awesome-product |
+
+### GITHUB_HEAD_REF_SLUG_URL
+
+URL-safe slug of **GITHUB_HEAD_REF** -- the branch of the head repository.
+_Only set for [`pull_request*`][webhooks] events and forked repositories._
+
+| GITHUB_HEAD_REF | GITHUB_HEAD_REF_SLUG_URL |
+| --------------- | ------------------------ |
+| main | main |
+| feat/new_feature | feat-new-feature |
+| New_Awesome_Product | new-awesome-product |
+
+### GITHUB_BASE_REF_SLUG_URL
+
+URL-safe slug of **GITHUB_BASE_REF** -- the branch of the base repository.
+_Only set for [`pull_request*`][webhooks] events and forked repositories._
+
+| GITHUB_BASE_REF | GITHUB_BASE_REF_SLUG_URL |
+| --------------- | ------------------------ |
+| main | main |
+| feat/new_feature | feat-new-feature |
+| New_Awesome_Product | new-awesome-product |
+
+### GITHUB_EVENT_REF_SLUG_URL
+
+URL-safe slug of **github.event.ref** -- the Git reference resource associated to the triggered webhook.
+_Only set for [`create` and `delete`][webhooks] events._
+
+| github.event.ref | GITHUB_EVENT_REF_SLUG_URL |
+| ---------------- | ------------------------- |
+| main | main |
+| feat/new_feature | feat-new-feature |
+| New_Awesome_Product | new-awesome-product |
+
+---
+
+## Short Variables
+
+### GITHUB_SHA_SHORT
+
+Shortened **GITHUB_SHA** -- the commit SHA that triggered the workflow.
+
+| GITHUB_SHA | GITHUB_SHA_SHORT |
+| ---------- | ---------------- |
+| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e |
+
+### GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT
+
+Shortened value of `github.event.pull_request.head.sha` -- the last commit on the pull request that triggered the workflow.
+
+| github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
+| ---------------------------------- | ---------------------------------------- |
+| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e |
+
+---
+
+## Case-Sensitive Variants
+
+All slug and slug-url variables have a `_CS` suffix variant that preserves the original casing. The `_CS` variant applies the same transformation but skips the lowercase step.
+
+| Standard | Case-Sensitive |
+| -------- | -------------- |
+| `GITHUB_REPOSITORY_SLUG` | `GITHUB_REPOSITORY_SLUG_CS` |
+| `GITHUB_REPOSITORY_SLUG_URL` | `GITHUB_REPOSITORY_SLUG_URL_CS` |
+| `GITHUB_REF_SLUG` | `GITHUB_REF_SLUG_CS` |
+| `GITHUB_REF_SLUG_URL` | `GITHUB_REF_SLUG_URL_CS` |
+| _(and so on for all slug/slug-url variables)_ | |
+
+Example:
+
+| Input | SLUG | SLUG_CS |
+| ----- | ---- | ------- |
+| `refs/heads/New_Awesome_Product` | `new-awesome-product` | `New-Awesome-Product` |
+
+---
+
+## Variable Availability by Event
+
+Not all variables are set for every event type. See [GitHub variables by event](github-variables.md) for the full matrix.
+
+[webhooks]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads

docs/short-variables.md

@@ -1,27 +1,3 @@
 # Short Variables
 
-## Table of Contents
-
-- [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
-
-Short the environment variable **GITHUB_SHA**
-
-The commit SHA that triggered the workflow
-
-| 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                                 |
+This page has moved to [reference/variables.md](reference/variables.md#short-variables).

docs/slug-url-variables.md

@@ -1,109 +1,3 @@
 # Slug URL Variables
 
-## Table of Contents
-
-- [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
-
-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   |
-| AnotherPerson/SomeRepository | anotherperson-somerepository |
-
-## GITHUB_REPOSITORY_OWNER_PART_SLUG_URL
-
-Slug URL the environment variable [GITHUB_REPOSITORY_OWNER_PART](partial-variables.md#github_repository_owner_part)
-
-The Owner part of **GITHUB_REPOSITORY** variable.
-
-| GITHUB_REPOSITORY_OWNER_PART | GITHUB_REPOSITORY_OWNER_PART_SLUG_URL |
-| ---------------------------- | ------------------------------------- |
-| octocat                      | octocat                               |
-| rlespinasse                  | rlespinasse                           |
-| AnotherPerson                | anotherperson                         |
-
-## GITHUB_REPOSITORY_NAME_PART_SLUG_URL
-
-Slug URL the environment variable [GITHUB_REPOSITORY_NAME_PART](partial-variables.md#github_repository_name_part)
-
-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                       |
-
-## GITHUB_REF_SLUG_URL
-
-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  |
-| 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_HEAD_REF_SLUG_URL
-
-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_BASE_REF_SLUG_URL
-
-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_EVENT_REF_SLUG_URL
-
-Slug URL the variable **github.event.ref**
-
-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      |
-
-[1]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
+This page has moved to [reference/variables.md](reference/variables.md#url-safe-slug-variables).

docs/slug-variables.md

@@ -1,105 +1,3 @@
 # Slug Variables
 
-## Table of Contents
-
-- [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
-
-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   |
-| AnotherPerson/SomeRepository | anotherperson-somerepository |
-
-## GITHUB_REPOSITORY_OWNER_PART_SLUG
-
-Slug the environment variable [GITHUB_REPOSITORY_OWNER_PART](partial-variables.md#github_repository_owner_part)
-
-The Owner part of **GITHUB_REPOSITORY** variable.
-
-| GITHUB_REPOSITORY_OWNER_PART | GITHUB_REPOSITORY_OWNER_PART_SLUG |
-| ---------------------------- | --------------------------------- |
-| octocat                      | octocat                           |
-| rlespinasse                  | rlespinasse                       |
-| AnotherPerson                | anotherperson                     |
-
-## GITHUB_REPOSITORY_NAME_PART_SLUG
-
-Slug the environment variable [GITHUB_REPOSITORY_NAME_PART](partial-variables.md#github_repository_name_part)
-
-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                   |
-
-## GITHUB_REF_SLUG
-
-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  |
-| refs/heads/New_Awesome_Product | new-awesome-product |
-
-## GITHUB_HEAD_REF_SLUG
-
-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_BASE_REF_SLUG
-
-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_EVENT_REF_SLUG
-
-Slug the variable **github.event.ref**
-
-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  |
-
-[1]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
+This page has moved to [reference/variables.md](reference/variables.md#slug-variables).

examples/linux-usage.yml

@@ -6,8 +6,8 @@ jobs:
   usage:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rlespinasse/github-slug-action@v3.x
+      - uses: actions/checkout@v6
+      - 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@v3.x
+      - uses: actions/checkout@v6
+      - 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@v3.x
+      - uses: actions/checkout@v6
+      - 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@v3.x
+      - uses: actions/checkout@v6
+      - 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@v3.x
+      - uses: actions/checkout@v6
+      - uses: rlespinasse/github-slug-action@v5
       - name: Output
         run: |
           echo "Partial variables"

jest.config.js

@@ -1,11 +0,0 @@
-module.exports = {
-  clearMocks: true,
-  moduleFileExtensions: ['js', 'ts'],
-  testEnvironment: 'node',
-  testMatch: ['**/*.test.ts'],
-  testRunner: 'jest-circus/runner',
-  transform: {
-    '^.+\\.ts$': 'ts-jest'
-  },
-  verbose: true
-}

package.json

@@ -1,72 +0,0 @@
-{
-  "name": "github-slug-action",
-  "version": "0.0.0",
-  "license": "MIT",
-  "private": true,
-  "description": "Github slug action",
-  "main": "lib/main.js",
-  "scripts": {
-    "release": "semantic-release",
-    "build": "tsc",
-    "format": "prettier --write **/*.ts",
-    "format-check": "prettier --check **/*.ts",
-    "lint": "eslint src/**/*.ts",
-    "package": "ncc build --source-map",
-    "test": "jest",
-    "all": "npm run build && npm run format && npm run lint && npm run package && npm test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/rlespinasse/github-slug-action.git"
-  },
-  "keywords": [
-    "actions",
-    "node",
-    "setup"
-  ],
-  "author": "rlespinasse",
-  "dependencies": {
-    "@actions/core": "^1.10.0"
-  },
-  "devDependencies": {
-    "@semantic-release/changelog": "^6.0.1",
-    "@semantic-release/exec": "^6.0.0",
-    "@semantic-release/git": "^10.0.1",
-    "@types/jest": "^26.0.24",
-    "@types/node": "^14.18.25",
-    "@typescript-eslint/eslint-plugin": "^5.38.1",
-    "@vercel/ncc": "^0.36.1",
-    "eslint": "^8.0.1",
-    "eslint-plugin-github": "^4.3.7",
-    "eslint-plugin-jest": "^23.20.0",
-    "jest": "^26.6.3",
-    "jest-circus": "^26.6.3",
-    "js-yaml": "^3.14.1",
-    "prettier": "^2.7.1",
-    "semantic-release": "^19.0.3",
-    "ts-jest": "^26.5.6",
-    "typescript": "^4.2.0"
-  },
-  "files": [
-    "/dist"
-  ],
-  "release": {
-    "tagFormat": "v${version}",
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/changelog",
-      [
-        "@semantic-release/exec",
-        {
-          "prepareCmd": "git add dist"
-        }
-      ],
-      "@semantic-release/git",
-      "@semantic-release/github"
-    ],
-    "branches": [
-      "v3.x"
-    ]
-  }
-}

preflight.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+if [ -z "${INPUT_SLUG_MAXLENGTH}" ]; then
+  echo "::error ::slug-maxlength cannot be empty"
+  exit 1
+elif [ "${INPUT_SLUG_MAXLENGTH}" != "nolimit" ] && [ ! "${INPUT_SLUG_MAXLENGTH}" -eq "${INPUT_SLUG_MAXLENGTH}" ] 2>/dev/null; then
+  echo "::error ::slug-maxlength must be a number or equals to 'nolimit'"
+  exit 1
+fi
+
+if [ ! "${INPUT_SHORT_LENGTH}" -eq "${INPUT_SHORT_LENGTH}" ] 2>/dev/null; then
+  echo "::error ::short-length must be a number"
+  exit 1
+fi
+
+echo "::debug ::Control preflight short-length setup"
+PREFLIGHT_SHORT_LENGTH=""
+if [ -n "${INPUT_SHORT_LENGTH}" ]; then
+  PREFLIGHT_SHORT_LENGTH="${INPUT_SHORT_LENGTH}"
+  echo "::debug ::Use input value: $PREFLIGHT_SHORT_LENGTH"
+elif [ "$(git rev-parse --is-inside-work-tree)" == "true" ]; then
+  echo "::debug ::The action run inside a git repository, short-length can be empty"
+else
+  echo "::debug ::The action run outside a git repository, need to set short-length"
+  PREFLIGHT_SHORT_LENGTH="$(git config --get core.abbrev)"
+  if [ -n "${PREFLIGHT_SHORT_LENGTH}" ]; then
+    echo "::debug ::Git Configuration 'core.abbrev' is set, using it as short-length"
+  else
+    PREFLIGHT_SHORT_LENGTH="7"
+    echo "::debug ::Using fallback value for short-length"
+  fi
+fi
+echo "::debug ::Set PREFLIGHT_SHORT_LENGTH=$PREFLIGHT_SHORT_LENGTH"
+if [ -f "$GITHUB_OUTPUT" ]; then
+  echo "PREFLIGHT_SHORT_LENGTH=${PREFLIGHT_SHORT_LENGTH}" >> "$GITHUB_OUTPUT"
+else
+  echo "::set-output name=PREFLIGHT_SHORT_LENGTH::${PREFLIGHT_SHORT_LENGTH}"
+fi

src/main.ts

@@ -1,401 +0,0 @@
-import * as core from '@actions/core'
-import {
-  removeRef,
-  slug,
-  slug_cs,
-  slugref,
-  slugref_cs,
-  slugurl,
-  slugurl_cs,
-  slugurlref,
-  slugurlref_cs
-} from './slug'
-import {shortsha} from './short'
-import {get_first_part, get_second_part} from './partial'
-
-const SEPARATOR = '/'
-
-/**
- * Inputs environments variables keys from Github actions job
- * see https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
- */
-const GITHUB_REPOSITORY = 'GITHUB_REPOSITORY'
-const GITHUB_REF = 'GITHUB_REF'
-const GITHUB_HEAD_REF = 'GITHUB_HEAD_REF'
-const GITHUB_BASE_REF = 'GITHUB_BASE_REF'
-const GITHUB_SHA = 'GITHUB_SHA'
-const GITHUB_EVENT_PATH = 'GITHUB_EVENT_PATH'
-
-/**
- * Partial outputs environments variables keys
- */
-const GITHUB_REPOSITORY_OWNER_PART = 'GITHUB_REPOSITORY_OWNER_PART'
-const GITHUB_REPOSITORY_NAME_PART = 'GITHUB_REPOSITORY_NAME_PART'
-
-/**
- * New environments variables keys
- */
-const GITHUB_REF_NAME = 'GITHUB_REF_NAME'
-
-/**
- * Slugged outputs environments variables keys
- */
-const GITHUB_REPOSITORY_SLUG = 'GITHUB_REPOSITORY_SLUG'
-const GITHUB_REPOSITORY_SLUG_CS = 'GITHUB_REPOSITORY_SLUG_CS'
-const GITHUB_REPOSITORY_OWNER_PART_SLUG = 'GITHUB_REPOSITORY_OWNER_PART_SLUG'
-const GITHUB_REPOSITORY_OWNER_PART_SLUG_CS =
-  'GITHUB_REPOSITORY_OWNER_PART_SLUG_CS'
-const GITHUB_REPOSITORY_NAME_PART_SLUG = 'GITHUB_REPOSITORY_NAME_PART_SLUG'
-const GITHUB_REPOSITORY_NAME_PART_SLUG_CS =
-  'GITHUB_REPOSITORY_NAME_PART_SLUG_CS'
-const GITHUB_REF_SLUG = 'GITHUB_REF_SLUG'
-const GITHUB_REF_SLUG_CS = 'GITHUB_REF_SLUG_CS'
-const GITHUB_HEAD_REF_SLUG = 'GITHUB_HEAD_REF_SLUG'
-const GITHUB_HEAD_REF_SLUG_CS = 'GITHUB_HEAD_REF_SLUG_CS'
-const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG'
-const GITHUB_BASE_REF_SLUG_CS = 'GITHUB_BASE_REF_SLUG_CS'
-const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG'
-const GITHUB_EVENT_REF_SLUG_CS = 'GITHUB_EVENT_REF_SLUG_CS'
-const GITHUB_REF_NAME_SLUG = 'GITHUB_REF_NAME_SLUG'
-const GITHUB_REF_NAME_SLUG_CS = 'GITHUB_REF_NAME_SLUG_CS'
-
-/**
- * URL-Slugged outputs environments variables keys
- */
-const GITHUB_REPOSITORY_SLUG_URL = 'GITHUB_REPOSITORY_SLUG_URL'
-const GITHUB_REPOSITORY_SLUG_URL_CS = 'GITHUB_REPOSITORY_SLUG_URL_CS'
-const GITHUB_REPOSITORY_OWNER_PART_SLUG_URL =
-  'GITHUB_REPOSITORY_OWNER_PART_SLUG_URL'
-const GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS =
-  'GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS'
-const GITHUB_REPOSITORY_NAME_PART_SLUG_URL =
-  'GITHUB_REPOSITORY_NAME_PART_SLUG_URL'
-const GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS =
-  'GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS'
-const GITHUB_REF_SLUG_URL = 'GITHUB_REF_SLUG_URL'
-const GITHUB_REF_SLUG_URL_CS = 'GITHUB_REF_SLUG_URL_CS'
-const GITHUB_HEAD_REF_SLUG_URL = 'GITHUB_HEAD_REF_SLUG_URL'
-const GITHUB_HEAD_REF_SLUG_URL_CS = 'GITHUB_HEAD_REF_SLUG_URL_CS'
-const GITHUB_BASE_REF_SLUG_URL = 'GITHUB_BASE_REF_SLUG_URL'
-const GITHUB_BASE_REF_SLUG_URL_CS = 'GITHUB_BASE_REF_SLUG_URL_CS'
-const GITHUB_EVENT_REF_SLUG_URL = 'GITHUB_EVENT_REF_SLUG_URL'
-const GITHUB_EVENT_REF_SLUG_URL_CS = 'GITHUB_EVENT_REF_SLUG_URL_CS'
-const GITHUB_REF_NAME_SLUG_URL = 'GITHUB_REF_NAME_SLUG_URL'
-const GITHUB_REF_NAME_SLUG_URL_CS = 'GITHUB_REF_NAME_SLUG_URL_CS'
-
-/**
- * Shorted outputs environments variables keys
- */
-const GITHUB_SHA_SHORT = 'GITHUB_SHA_SHORT'
-const GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT =
-  'GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT'
-
-async function run(): Promise<void> {
-  try {
-    const eventPath = process.env[GITHUB_EVENT_PATH]
-    if (eventPath) {
-      const eventData = await import(eventPath)
-      if (eventData.hasOwnProperty('ref')) {
-        core.exportVariable(GITHUB_EVENT_REF_SLUG, slugref(eventData.ref))
-        core.exportVariable(GITHUB_EVENT_REF_SLUG_CS, slugref_cs(eventData.ref))
-        core.exportVariable(
-          GITHUB_EVENT_REF_SLUG_URL,
-          slugurlref(eventData.ref)
-        )
-        core.exportVariable(
-          GITHUB_EVENT_REF_SLUG_URL_CS,
-          slugurlref_cs(eventData.ref)
-        )
-      } else if (eventData.hasOwnProperty('pull_request')) {
-        core.exportVariable(
-          GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT,
-          shortsha(eventData.pull_request.head.sha)
-        )
-      }
-    }
-
-    exportFirstPart(GITHUB_REPOSITORY, SEPARATOR, GITHUB_REPOSITORY_OWNER_PART)
-    exportSecondPart(GITHUB_REPOSITORY, SEPARATOR, GITHUB_REPOSITORY_NAME_PART)
-
-    exportSlug(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG)
-    exportSlugCS(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_CS)
-    exportFirstPartSlug(
-      GITHUB_REPOSITORY,
-      SEPARATOR,
-      GITHUB_REPOSITORY_OWNER_PART_SLUG
-    )
-    exportFirstPartSlugCS(
-      GITHUB_REPOSITORY,
-      SEPARATOR,
-      GITHUB_REPOSITORY_OWNER_PART_SLUG_CS
-    )
-    exportSecondPartSlug(
-      GITHUB_REPOSITORY,
-      SEPARATOR,
-      GITHUB_REPOSITORY_NAME_PART_SLUG
-    )
-    exportSecondPartSlugCS(
-      GITHUB_REPOSITORY,
-      SEPARATOR,
-      GITHUB_REPOSITORY_NAME_PART_SLUG_CS
-    )
-
-    exportSlugUrl(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_URL)
-    exportSlugUrlCS(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_URL_CS)
-    exportFirstPartSlugUrl(
-      GITHUB_REPOSITORY,
-      SEPARATOR,
-      GITHUB_REPOSITORY_OWNER_PART_SLUG_URL
-    )
-    exportFirstPartSlugUrlCS(
-      GITHUB_REPOSITORY,
-      SEPARATOR,
-      GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS
-    )
-    exportSecondPartSlugUrl(
-      GITHUB_REPOSITORY,
-      SEPARATOR,
-      GITHUB_REPOSITORY_NAME_PART_SLUG_URL
-    )
-    exportSecondPartSlugUrlCS(
-      GITHUB_REPOSITORY,
-      SEPARATOR,
-      GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS
-    )
-
-    exportSlugRef(GITHUB_REF, GITHUB_REF_SLUG)
-    exportSlugRefCS(GITHUB_REF, GITHUB_REF_SLUG_CS)
-    exportSlugRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG)
-    exportSlugRefCS(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_CS)
-    exportSlugRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG)
-    exportSlugRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_CS)
-
-    exportSlugUrlRef(GITHUB_REF, GITHUB_REF_SLUG_URL)
-    exportSlugUrlRefCS(GITHUB_REF, GITHUB_REF_SLUG_URL_CS)
-    exportSlugUrlRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_URL)
-    exportSlugUrlRefCS(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_URL_CS)
-    exportSlugUrlRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL)
-    exportSlugUrlRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL_CS)
-
-    exportShortSha(GITHUB_SHA, GITHUB_SHA_SHORT)
-
-    exportBranchName()
-  } catch (error) {
-    if (error instanceof Error) core.setFailed(error.message)
-  }
-}
-
-function exportFirstPart(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, get_first_part(envVar, separator))
-  }
-}
-
-function exportSecondPart(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, get_second_part(envVar, separator))
-  }
-}
-
-function exportSlugCS(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, slug_cs(envVar))
-  }
-}
-function exportSlug(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, slug(envVar))
-  }
-}
-
-function exportFirstPartSlugCS(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    const value = get_first_part(envVar, separator)
-    core.exportVariable(outputKey, slug_cs(value))
-  }
-}
-
-function exportFirstPartSlug(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    const value = get_first_part(envVar, separator)
-    core.exportVariable(outputKey, slug(value))
-  }
-}
-
-function exportSecondPartSlugCS(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    const value = get_second_part(envVar, separator)
-    core.exportVariable(outputKey, slug_cs(value))
-  }
-}
-
-function exportSecondPartSlug(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    const value = get_second_part(envVar, separator)
-    core.exportVariable(outputKey, slug(value))
-  }
-}
-
-function exportSlugRefCS(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    exportSlugRefCSValue(envVar, outputKey)
-  }
-}
-
-function exportSlugRefCSValue(envVar: string, outputKey: string): void {
-  core.exportVariable(outputKey, slugref_cs(envVar))
-}
-
-function exportSlugRef(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    exportSlugRefValue(envVar, outputKey)
-  }
-}
-
-function exportSlugRefValue(envVar: string, outputKey: string): void {
-  core.exportVariable(outputKey, slugref(envVar))
-}
-
-function exportSlugUrlCS(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, slugurl_cs(envVar))
-  }
-}
-function exportSlugUrl(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, slugurl(envVar))
-  }
-}
-
-function exportFirstPartSlugUrlCS(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    const value = get_first_part(envVar, separator)
-    core.exportVariable(outputKey, slugurl_cs(value))
-  }
-}
-
-function exportFirstPartSlugUrl(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    const value = get_first_part(envVar, separator)
-    core.exportVariable(outputKey, slugurl(value))
-  }
-}
-
-function exportSecondPartSlugUrlCS(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    const value = get_second_part(envVar, separator)
-    core.exportVariable(outputKey, slugurl_cs(value))
-  }
-}
-
-function exportSecondPartSlugUrl(
-  inputKey: string,
-  separator: string,
-  outputKey: string
-): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    const value = get_second_part(envVar, separator)
-    core.exportVariable(outputKey, slugurl(value))
-  }
-}
-
-function exportSlugUrlRefCS(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    exportSlugUrlRefCSValue(envVar, outputKey)
-  }
-}
-
-function exportSlugUrlRefCSValue(envVar: string, outputKey: string): void {
-  core.exportVariable(outputKey, slugurlref_cs(envVar))
-}
-
-function exportSlugUrlRef(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    exportSlugUrlRefValue(envVar, outputKey)
-  }
-}
-
-function exportSlugUrlRefValue(envVar: string, outputKey: string): void {
-  core.exportVariable(outputKey, slugurlref(envVar))
-}
-
-function exportShortSha(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, shortsha(envVar))
-  }
-}
-
-function exportBranchName(): void {
-  //GITHUB_HEAD_REF is only set for pull request events https://docs.github.com/en/actions/reference/environment-variables
-  const isPullRequest = !!process.env.GITHUB_HEAD_REF
-  let refName
-  if (isPullRequest) {
-    refName = process.env.GITHUB_HEAD_REF
-  } else {
-    refName = process.env.GITHUB_REF
-  }
-  if (refName) {
-    core.exportVariable(GITHUB_REF_NAME, removeRef(refName))
-    exportSlugRefValue(refName, GITHUB_REF_NAME_SLUG)
-    exportSlugRefCSValue(refName, GITHUB_REF_NAME_SLUG_CS)
-    exportSlugUrlRefValue(refName, GITHUB_REF_NAME_SLUG_URL)
-    exportSlugUrlRefCSValue(refName, GITHUB_REF_NAME_SLUG_URL_CS)
-  }
-}
-
-run()

src/partial.ts

@@ -1,17 +0,0 @@
-/**
- * Get the first part of envVar
- * @param envVar to be split
- * @param separator of the split
- */
-export function get_first_part(envVar: string, separator: string): string {
-  return envVar.replace(RegExp(`${separator}.*$`), '')
-}
-
-/**
- * Get the second part of envVar
- * @param envVar to be split
- * @param separator of the split
- */
-export function get_second_part(envVar: string, separator: string): string {
-  return envVar.replace(RegExp(`^.*${separator}`), '')
-}

src/short.ts

@@ -1,10 +0,0 @@
-const SHORT_SHA_SIZE = 8
-
-/**
- * slug will take envVar and then :
- * - limit the string size to 8 characters
- * @param envVar to be slugged
- */
-export function shortsha(envVar: string): string {
-  return envVar.substring(0, SHORT_SHA_SIZE)
-}

src/slug.ts

@@ -1,129 +0,0 @@
-const MAX_SLUG_STRING_SIZE = 63
-
-/**
- * slug_cs will take envVar and then :
- * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
- * - remove leading `-` characters
- * - limit the string size to 63 characters
- * - remove trailing `-` characters
- * @param envVar to be slugged
- */
-export function slug_cs(envVar: string): string {
-  return removeTrailingHyphens(
-    removeLeadingHyphens(replaceAnyNonAlphanumericCharacter(envVar)).substring(
-      0,
-      MAX_SLUG_STRING_SIZE
-    )
-  )
-}
-
-/**
- * slug will take envVar and then :
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
- * - remove leading `-` characters
- * - limit the string size to 63 characters
- * - remove trailing `-` characters
- * @param envVar to be slugged
- */
-export function slug(envVar: string): string {
-  return slug_cs(envVar.toLowerCase())
-}
-
-/**
- * slugref_cs will take envVar and then :
- * - remove refs/(heads|tags|pull)/
- * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
- * - remove leading `-` characters
- * - limit the string size to 63 characters
- * - remove trailing `-` characters
- * @param envVar to be slugged
- */
-export function slugref_cs(envVar: string): string {
-  return slug_cs(removeRef(envVar))
-}
-
-/**
- * slugref will take envVar and then :
- * - remove refs/(heads|tags|pull)/
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
- * - remove leading `-` characters
- * - limit the string size to 63 characters
- * - remove trailing `-` characters
- * @param envVar to be slugged
- */
-export function slugref(envVar: string): string {
-  return slugref_cs(envVar.toLowerCase())
-}
-
-/**
- * slugurl_cs will take envVar and then :
- * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading `-` characters
- * - limit the string size to 63 characters
- * - remove trailing `-` characters
- * @param envVar to be slugged
- */
-export function slugurl_cs(envVar: string): string {
-  return slug_cs(replaceAnyNonUrlCharactersWithHyphen(envVar))
-}
-
-/**
- * slugurl will take envVar and then :
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading `-` characters
- * - limit the string size to 63 characters
- * - remove trailing `-` characters
- * @param envVar to be slugged
- */
-export function slugurl(envVar: string): string {
-  return slugurl_cs(envVar.toLowerCase())
-}
-
-/**
- * slugurlref_cs will take envVar and then :
- * - remove refs/(heads|tags|pull)/
- * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading `-` characters
- * - limit the string size to 63 characters
- * - remove trailing `-` characters
- * @param envVar to be slugged
- */
-export function slugurlref_cs(envVar: string): string {
-  return slugurl_cs(removeRef(envVar))
-}
-
-/**
- * slugurlref will take envVar and then :
- * - remove refs/(heads|tags|pull)/
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading `-` characters
- * - limit the string size to 63 characters
- * - remove trailing `-` characters
- * @param envVar to be slugged
- */
-export function slugurlref(envVar: string): string {
-  return slugurlref_cs(envVar.toLowerCase())
-}
-
-function removeLeadingHyphens(envVar: string): string {
-  return envVar.replace(RegExp('^-*', 'g'), '')
-}
-function removeTrailingHyphens(envVar: string): string {
-  return envVar.replace(RegExp('-*$', 'g'), '')
-}
-
-function replaceAnyNonAlphanumericCharacter(envVar: string): string {
-  return envVar.replace(RegExp('[^a-zA-Z0-9._]', 'g'), '-')
-}
-
-function replaceAnyNonUrlCharactersWithHyphen(envVar: string): string {
-  return envVar.replace(RegExp('[._]', 'g'), '-')
-}
-
-export function removeRef(envVar: string): string {
-  return envVar.replace(RegExp('^refs/(heads|tags|pull)/'), '')
-}

tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
-    "outDir": "./lib",                        /* Redirect output structure to the directory. */
-    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
-    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-  },
-  "exclude": ["node_modules", "**/*.test.ts"]
-}