feat: add option to set a different slug length than 63

fix(short): populate GITHUB_SHA_SHORT correctly
docs(readme): reword troubleshooting section
2026-05-18 06:35:10 +00:00 · 2022-03-19 22:50:08 +01:00 · 2022-03-19 11:35:00 +01:00 · 2022-01-01 15:15:35 +01:00 · 2022-01-01 15:06:51 +01:00 · 2022-01-01 14:23:29 +01:00
38 changed files with 1060 additions and 17273 deletions
--- a/.dependabot/config.xml
+++ b/.dependabot/config.xml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
--- a/.eslintignore
+++ b/.eslintignore
@@ -1,3 +0,0 @@
-dist/
-lib/
-node_modules/
--- a/.eslintrc.json
+++ b/.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
-    }
-  }
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,65 +0,0 @@
-name: Build
-on: [push, pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - run: |
-          npm ci
-      - run: |
-          npm run all
-      - uses: cycjimmy/semantic-release-action@v2
-        with:
-          semantic_version: 17.0.7
-          branches: |
-            [
-              'v2.x',
-              'v3.x'
-            ]
-          extra_plugins: |
-            @semantic-release/changelog@5.0.1
-            @semantic-release/git@9.0.0
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-  test: # make sure the action works on a clean machine without building
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          - macos-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ./
-      - run: |
-          echo $GITHUB_REPOSITORY_SLUG
-          echo $GITHUB_REPOSITORY_SLUG_URL
-          echo $GITHUB_REF_SLUG
-          echo $GITHUB_HEAD_REF_SLUG
-          echo $GITHUB_BASE_REF_SLUG
-          echo $GITHUB_EVENT_REF_SLUG
-          echo $GITHUB_REF_SLUG_URL
-          echo $GITHUB_HEAD_REF_SLUG_URL
-          echo $GITHUB_BASE_REF_SLUG_URL
-          echo $GITHUB_EVENT_REF_SLUG_URL
-          echo $GITHUB_SHA_SHORT
-
-  test-win:
-    runs-on: windows-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ./
-      - run: |
-          echo $env:GITHUB_REPOSITORY_SLUG
-          echo $env:GITHUB_REPOSITORY_SLUG_URL
-          echo $env:GITHUB_REF_SLUG
-          echo $env:GITHUB_HEAD_REF_SLUG
-          echo $env:GITHUB_BASE_REF_SLUG
-          echo $env:GITHUB_EVENT_REF_SLUG
-          echo $env:GITHUB_REF_SLUG_URL
-          echo $env:GITHUB_HEAD_REF_SLUG_URL
-          echo $env:GITHUB_BASE_REF_SLUG_URL
-          echo $env:GITHUB_EVENT_REF_SLUG_URL
-          echo $env:GITHUB_SHA_SHORT
--- a/.github/workflows/github-slug-action.yml
+++ b/.github/workflows/github-slug-action.yml
@@ -0,0 +1,220 @@
+name: Github Slug Action testing
+on: [push, pull_request]
+jobs:
+  os-testing:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Load using v3.x
+        uses: rlespinasse/github-slug-action@v3.x
+      - name: Load using v4.x with prefix
+        uses: ./
+        with:
+          prefix: V4_
+      - name: Validate // Partial variables
+        run: |
+          echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART }}"
+          echo "repository name  : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART }}"
+          [[ "${{ 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: |
+          echo "repository       : ${{ env.V4_GITHUB_REPOSITORY_SLUG }}"
+          echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG }}"
+          echo "repository name  : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG }}"
+          echo "ref              : ${{ env.V4_GITHUB_REF_SLUG }}"
+          echo "head ref         : ${{ env.V4_GITHUB_HEAD_REF_SLUG }}"
+          echo "base ref         : ${{ env.V4_GITHUB_BASE_REF_SLUG }}"
+          echo "event ref        : ${{ env.V4_GITHUB_EVENT_REF_SLUG }}"
+          [[ "${{ 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: |
+          echo "repository       : ${{ env.V4_GITHUB_REPOSITORY_SLUG_CS }}"
+          echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}"
+          echo "repository name  : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}"
+          echo "ref              : ${{ env.V4_GITHUB_REF_SLUG_CS }}"
+          echo "head ref         : ${{ env.V4_GITHUB_HEAD_REF_SLUG_CS }}"
+          echo "base ref         : ${{ env.V4_GITHUB_BASE_REF_SLUG_CS }}"
+          echo "event ref        : ${{ env.V4_GITHUB_EVENT_REF_SLUG_CS }}"
+          [[ "${{ 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: |
+          echo "repository       : ${{ env.V4_GITHUB_REPOSITORY_SLUG_URL }}"
+          echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}"
+          echo "repository name  : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}"
+          echo "ref              : ${{ env.V4_GITHUB_REF_SLUG_URL }}"
+          echo "head ref         : ${{ env.V4_GITHUB_HEAD_REF_SLUG_URL }}"
+          echo "base ref         : ${{ env.V4_GITHUB_BASE_REF_SLUG_URL }}"
+          echo "event ref        : ${{ env.V4_GITHUB_EVENT_REF_SLUG_URL }}"
+          [[ "${{ 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: |
+          echo "repository       : ${{ env.V4_GITHUB_REPOSITORY_SLUG_URL_CS }}"
+          echo "repository owner : ${{ env.V4_GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}"
+          echo "repository name  : ${{ env.V4_GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}"
+          echo "ref              : ${{ env.V4_GITHUB_REF_SLUG_URL_CS }}"
+          echo "head ref         : ${{ env.V4_GITHUB_HEAD_REF_SLUG_URL_CS }}"
+          echo "base ref         : ${{ env.V4_GITHUB_BASE_REF_SLUG_URL_CS }}"
+          echo "event ref        : ${{ env.V4_GITHUB_EVENT_REF_SLUG_URL_CS }}"
+          [[ "${{ 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 Name
+        run: |
+          echo "raw                       : ${{ env.V4_GITHUB_REF_NAME }}"
+          echo "slug                      : ${{ env.V4_GITHUB_REF_NAME_SLUG }}"
+          echo "slug url                  : ${{ env.V4_GITHUB_REF_NAME_SLUG_URL }}"
+          echo "slug (Case Sensitive)     : ${{ env.V4_GITHUB_REF_NAME_SLUG_CS }}"
+          echo "slug url (Case Sensitive) : ${{ env.V4_GITHUB_REF_NAME_SLUG_URL_CS }}"
+          [[ "${{ env.GITHUB_REF_NAME }}" == "${{ env.V4_GITHUB_REF_NAME }}" ]]
+          [[ "${{ env.GITHUB_REF_NAME_SLUG }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG }}" ]]
+          [[ "${{ env.GITHUB_REF_NAME_SLUG_URL }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL }}" ]]
+          [[ "${{ env.GITHUB_REF_NAME_SLUG_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_CS }}" ]]
+          [[ "${{ env.GITHUB_REF_NAME_SLUG_URL_CS }}" == "${{ env.V4_GITHUB_REF_NAME_SLUG_URL_CS }}" ]]
+        shell: bash
+      - name: Validate // Short SHA variables
+        run: |
+          echo "sha              : ${{ env.V4_GITHUB_SHA_SHORT }}"
+          echo "pull request sha : ${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
+          [[ "${{ 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
+
+  os-testing-slug-maxlength:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      # Test 1
+      - name: Using correct max length
+        uses: ./
+        with:
+          prefix: "CML_"
+          slug-maxlength: 1
+      - name: Using correct max length // Validate that all slug variables are equals or under the slug-maxlength
+        run: |
+          env | grep "CML_" | grep "_SLUG" | cut -d"=" -f2 | while read -r value; do [ "$(echo "$value" | wc -m)" -le 2 ] ; done
+        shell: bash
+
+      # Test 2
+      - name: Using wrong max length
+        id: using-wrong-max-length
+        uses: ./
+        with:
+          prefix: "WML_"
+          slug-maxlength: "wrong"
+        continue-on-error: true
+      - name: Using wrong max length // Validate that the action end with an error
+        run: |
+          [[ "$(env | grep "WML_" | grep "_SLUG" | wc -l)" -eq 0 ]]
+          [[ "${{ steps.using-wrong-max-length.outcome }}" == "failure" ]]
+          [[ "${{ steps.using-wrong-max-length.conclusion }}" == "success" ]]
+        shell: bash
+
+      # Test 3
+      - name: Using empty max length
+        id: using-empty-max-length
+        uses: ./
+        with:
+          prefix: "EML_"
+          slug-maxlength: ""
+        continue-on-error: true
+      - name: Using empty max length // Validate that the action end with an error
+        run: |
+          [[ "$(env | grep "EML_" | grep "_SLUG" | wc -l)" -eq 0 ]]
+          [[ "${{ steps.using-empty-max-length.outcome }}" == "failure" ]]
+          [[ "${{ steps.using-empty-max-length.conclusion }}" == "success" ]]
+        shell: bash
+
+      # Test 4
+      - name: Using no limit on max length
+        id: using-nolimit-max-length
+        uses: ./
+        with:
+          prefix: "NLML_"
+          slug-maxlength: "nolimit"
+      - name: Using no limit on length // Validate that the action end with an error
+        run: |
+          [[ "$(env | grep "NLML_" | grep "_SLUG" | wc -l)" -gt 0 ]]
+          [[ "${{ steps.using-nolimit-max-length.outcome }}" == "success" ]]
+          [[ "${{ steps.using-nolimit-max-length.conclusion }}" == "success" ]]
+        shell: bash
+
+  os-testing-without-checkout:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          path: this-action
+          ref: ${{ github.ref }}
+      - name: Load using v3.x
+        uses: rlespinasse/github-slug-action@v3.x
+      - name: Load using v4.x with prefix
+        uses: ./this-action
+        with:
+          prefix: V4_
+      - name: Validate // Short SHA variables
+        run: |
+          echo "sha              : ${{ env.V4_GITHUB_SHA_SHORT }}"
+          echo "pull request sha : ${{ env.V4_GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
+          [[ "${{ 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
+
+  release:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: release-${{ github.ref }}-${{ github.event_name }}
+    needs:
+      - os-testing
+      - os-testing-slug-maxlength
+      - os-testing-without-checkout
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Release this GitHub Action
+        uses: rlespinasse/release-that@v1
+        with:
+          without-prefix: true
--- a/.gitignore
+++ b/.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/**/*
--- a/.prettierignore
+++ b/.prettierignore
@@ -1,3 +0,0 @@
-dist/
-lib/
-node_modules/
--- a/.prettierrc.json
+++ b/.prettierrc.json
@@ -1,10 +0,0 @@
-{
-  "printWidth": 80,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": false,
-  "singleQuote": true,
-  "trailingComma": "none",
-  "bracketSpacing": false,
-  "arrowParens": "avoid"
-}
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,50 @@
+# [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)


--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -18,11 +18,11 @@ 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.
+* Suggest your change by [opening a 'Feature request' issue][5]

 ## Do you have questions about the source code

-* [open a issue][3] with your question.
+* [open an issue][3] with your question.

 Thanks!

--- a/DEVELOPERS.md
+++ b/DEVELOPERS.md
@@ -1,26 +0,0 @@
-# Developers guide
-
-Install the dependencies
-
-```bash
-npm install
-```
-
-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)
-
-...
-```
--- a/README.md
+++ b/README.md
@@ -1,146 +1,212 @@
 # GitHub Slug action

-[![Actions Status][1]][2]
-[![Public workflows that use this action.][8]][9]
+[![Release][release-badge]][releases]
+![Lint][lint-badge]
+[![Licence][license-badge]][license]

-This action slug and expose some github variables.
+This GitHub Action will expose the slug/short values of [some GitHub environment variables][github-env-vars] inside your GitHub workflow.

-`Slug` a variable will
+## 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)
+  - [Troubleshooting](#troubleshooting)
+    - [One of the environment variables doesn't work as intended](#one-of-the-environment-variables-doesnt-work-as-intended)
+    - [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 `.`
+- replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
 - remove leading and trailing `-` character
 - limit the string size to 63 characters

-Others `Slug`-ish commands are available:
+<details>
+  <summary>Others <b>Slug-ish</b> commands are available</summary>
+  <p>

- `Slug URL` a variable will be like the `slug` variable but the `.` character will also be replaced by `-`
- `Short SHA` a variable will limit the string size to 8 characters
+- `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`

-## Exposed environment variables
+  </p>
+</details>
+
+Additional enhanced environment variables can be compute to help you around GitHub environment variables.
+
+## Use this action
+
+Add this in your workflow

 ```yaml
 - name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v3.x
-
- name: Print slug/short variables
-  run: |
-    echo "Slug variables"
-    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 }}"
-    echo "   repository : ${{ env.GITHUB_REPOSITORY_SLUG }}"
-    echo "Slug URL variables"
-    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 }}"
-    echo "   repository : ${{ env.GITHUB_REPOSITORY_SLUG_URL }}"
-    echo "Short SHA variables"
-    echo "   sha        : ${{ env.GITHUB_SHA_SHORT }}"
+  uses: rlespinasse/github-slug-action@v4
 ```

-Read [default environment variables][3] page for more information.
-
-### GITHUB_REF_SLUG / GITHUB_REF_SLUG_URL
-
-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     | GITHUB_REF_SLUG_URL |
-| ------------------------------ | ------------------- | ------------------- |
-| refs/heads/master              | master              | master              |
-| refs/heads/feat/new_feature    | feat-new-feature    | feat-new-feature    |
-| refs/tags/v1.0.0               | v1.0.0              | v1-0-0              |
-| refs/tags/product@1.0.0-rc.2   | product-1.0.0-rc.2  | product-1-0-0-rc-2  |
-| refs/heads/New_Awesome_Product | new-awesome-product | new-awesome-product |
-
-> **NOTE :**
-> GITHUB_REF_SLUG_URL is design to be used as subdomain in an URL.
-
-_Additional variables (only set for forked repositories) :_
-
- `GITHUB_HEAD_REF_SLUG`/`GITHUB_HEAD_REF_SLUG_URL`, The branch of the head repository **GITHUB_HEAD_REF**
- `GITHUB_BASE_REF_SLUG`/`GITHUB_BASE_REF_SLUG_URL`, The branch of the base repository **GITHUB_BASE_REF**
-
-_Additional variables (only set for [create][4], and [delete][5] webhook events with `ref` data) :_
-
- `GITHUB_EVENT_REF_SLUG`/`GITHUB_EVENT_REF_SLUG_URL`, The git reference resource associated to the webhook.
-
-### GITHUB_REPOSITORY_SLUG / GITHUB_REPOSITORY_SLUG_URL
-
-Slug the environment variable **GITHUB_REPOSITORY**
-
-The owner and repository name.
-
-| GITHUB_REPOSITORY          | GITHUB_REPOSITORY_SLUG     | GITHUB_REPOSITORY_SLUG_URL |
-| -------------------------- | -------------------------- | -------------------------- |
-| octocat/Hello-World        | octocat-hello-world        | octocat-hello-world        |
-| rlespinasse/Hello-World.go | rlespinasse-hello-world.go | rlespinasse-hello-world-go |
-
-> **NOTE :**
-> GITHUB_REPOSITORY_SLUG_URL is design to be used as subdomain in an URL.
-
-### GITHUB_SHA_SHORT
-
-Short the environment variable **GITHUB_SHA**
-
-The commit SHA that triggered the workflow
-
-| GITHUB_SHA                               | GITHUB_SHA_SHORT |
-| ---------------------------------------- | ---------------- |
-| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e         |
-
-### Use slug variable in an URL
-
-In an URL, use `<GITHUB_VARIABLE>_SLUG_URL` instead of **<GITHUB_VARIABLE>\_SLUG** as subdomain to be compliant.
-
-> **NOTE :**
-> <GITHUB*VARIABLE>\_SLUG can be used in an URL only as part of the \_resource path*.
+Or with a prefix

 ```yaml
 - name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v3.x
-
- name: Deploy dummy application using slug in the 'subdomain' part
-  run: |
-    ./deploy-application.sh --url "https://${{ env.<GITHUB_VARIABLE>_SLUG_URL }}.staging.app.mycompagny.com"
-
- name: Deploy dummy application using slug in the 'resource path' part
-  run: |
-    ./deploy-application.sh --url "https://staging.app.mycompagny.com/${{ env.<GITHUB_VARIABLE>_SLUG }}"
+  uses: rlespinasse/github-slug-action@v4
+  with:
+    prefix: CI_
 ```

-## Contribute
+Or with another max length for slug values

-Follow [Developers guide](DEVELOPERS.md)
+```yaml
+- name: Inject slug/short variables
+  uses: rlespinasse/github-slug-action@v4
+  with:
+    slug-maxlength: 80 # use 'nolimit' to remove use of a max length
+```
+
+Check for more [examples][examples] (OS usage, URL use, ...)
+
+**Tip:** Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows.
+
+## Available Environment variables
+
+**Note**: If you don't find what you search for, read more about [available `GitHub` variables](docs/github-variables.md), and propose a [new custom variable][custom-variable].
+
+### Enhanced variables
+
+- `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.
+
+**NOTE:** All enhanced variables are available in all **slug** formats.
+
+### Partial variables
+
+| Variable                                                                               | Partial version of | Description                                            |
+| -------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------ |
+| [GITHUB_REPOSITORY_OWNER_PART](docs/partial-variables.md#github_repository_owner_part) | GITHUB_REPOSITORY  | The Owner part of GITHUB_REPOSITORY variable           |
+| [GITHUB_REPOSITORY_NAME_PART](docs/partial-variables.md#github_repository_name_part)   | GITHUB_REPOSITORY  | The Repository name part of GITHUB_REPOSITORY variable |
+
+### Slug variables
+
+**NOTE:** `_CS` suffix available
+
+| 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>          |
+
+### Slug URL variables
+
+**NOTE:** `_CS` suffix available
+
+| 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>           |
+
+### Short variables
+
+| Variable                                                                                                             | Short version of                             | Description                                                                                                                                                                                                                                             |
+| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [GITHUB_SHA_SHORT](docs/short-variables.md#github_sha_short)                                                         | GITHUB_SHA                                   | The commit SHA that triggered the workflow.                                                                                                                                                                                                             |
+| [GITHUB_EVENT<br>_PULL_REQUEST<br>_HEAD_SHA_SHORT](docs/short-variables.md#github_event_pull_request_head_sha_short) | _github.event<br>.pull_request<br>.head.sha_ | The commit SHA on pull request that trigger workflow.<br>Only set for [following webhook events][webhooks-and-events]<ul><li>`pull_request`</li><li>`pull_request_review`</li><li>`pull_request_review_comment`</li><li>`pull_request_target`</li></ul> |

 ## Troubleshooting

-### Missing master branch
+### One of the environment variables doesn't work as intended

-If your workflow fail on the `Set up job` task with this kind of log :
+[**Note**][naming-conventions]: GitHub reserves the `GITHUB_` environment variable prefix for internal use by GitHub. Setting an environment variable or secret with the `GITHUB_` prefix will result in an error.

-```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'
+Currently, a GitHub workflow setting a `GITHUB_` variable will not cause an error, it will just fail silently.
+And if a custom `GITHUB_` variable is in conflict with an official `GITHUB_` variable, the offical `GITHUB_` variable will override custom one.
+
+<details>
+  <summary>Test workflow</summary>
+  <p>
+
+```yaml
+name: Test
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo ${GITHUB_REF}
+      # print "refs/heads/v4.x"
+      - run: echo "GITHUB_REF=one_value" >> "$GITHUB_ENV"
+      - run: echo ${GITHUB_REF}
+      # print "refs/heads/v4.x"
+      - run: echo "GITHUB_REF_SLUG=another_value" >> "$GITHUB_ENV"
+      - run: echo ${GITHUB_REF_SLUG}
+      # print "another_value"
 ```

-Please, use the current branch `v3.x` or a version tag (see [releases pages][6]) in order to fix your workflow.
+  </p>
+</details>

-> The master branch don't exists anymore.
->
-> The master branch EOL have been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][7])
+### An action could not be found at the URI

-[1]: https://github.com/rlespinasse/github-slug-action/workflows/Build/badge.svg
-[2]: https://github.com/rlespinasse/github-slug-action/actions
-[3]: https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
-[4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#create
-[5]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#delete
-[6]: https://github.com/rlespinasse/github-slug-action/releases
-[7]: https://github.com/rlespinasse/github-slug-action/issues/15
-[8]: https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Drlespinasse%2Fgithub-slug-action%26badge%3Dtrue
-[9]: https://github.com/search?o=desc&q=rlespinasse%2Frlespinasse/github-slug-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code
+If your workflow fail 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, the branch don't exists anymore following the [end-of-life for a branch](SECURITY.md#end-of-life-of-a-branch) security process.
+- `master`, the branch don't exists anymore, read more about it on the corresponding issue ([EOL issue][issue-15])
+
+Please, use the current major tag `v4` or a version tag (see [releases pages][releases]) in order to fix your workflow.
+
+## Thanks for talking about us
+
+- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1] (in french :fr:)
+- [Github Actions : enfin des pipelines accessibles aux développeurs][talk-1] (in french :fr:)
+- [Action spotlight by Michael Heap][article-2]
+- The next one is you. _Don't hesitate to add youself to this list._
+
+[release-badge]: https://img.shields.io/github/workflow/status/rlespinasse/github-slug-action/Release?label=Build&logo=github&style=flat-square
+[lint-badge]: https://img.shields.io/github/workflow/status/rlespinasse/github-slug-action/Lint?label=Lint&logo=github&style=flat-square
+[license-badge]: https://img.shields.io/github/license/rlespinasse/github-slug-action?style=flat-square
+
+[actions]: https://github.com/rlespinasse/github-slug-action/actions
+[license]: https://github.com/rlespinasse/github-slug-action/blob/v4.x/LICENSE
+[examples]: https://github.com/rlespinasse/github-slug-action/tree/v4.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
+
+[github-env-vars]: https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables
+[dependabot]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-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
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -2,15 +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:                |
+We only support 2 major versions for security patches
+
+| Version | Branch | Supported          | Specific Tags |
+| ------- | ------ | ------------------ | ------------- |
+| 4.x     | v4.x   | :white_check_mark: | v4            |
+| 3.x     | v3.x   | :white_check_mark: |               |
+| < 2.x   |        | :x:                | v2.x, v1.1.x  |

 A GitHub repository can used one of the available branches as action inside its workflows.

+### End of Life of a branch
+
+When a branch is not supported anymore, the following process occurs
+
+- Since `v4.x` branch, the branch will be deleted 2 major versions after
+  - So `v4.x` branch will be deleted when `v7.x` branch will have its first release
+  - prefer the `v4` tag to `v4.x` branch as reference in our workflow, 
+- Before `v4.x` branch, the branch will be converted into a tag when the support is dropped
+  - So `v3.x` branch will be converted as tag when `v5.x` branch will have its first release
+
 ## Reporting a Vulnerability

 You can report a Vulnerability by [my email](mailto:romain.lespinasse@gmail.com).
--- a/tests/shortsha.test.ts
+++ b/tests/shortsha.test.ts
@@ -1,10 +0,0 @@
-import {shortsha} from '../src/slug'
-
-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')
-})
--- a/tests/slug.test.ts
+++ b/tests/slug.test.ts
@@ -1,48 +0,0 @@
-import {slug} from '../src/slug'
-
-function test_slug(input: string, expected: string) {
-  let actual = slug(input)
-  expect(actual).toEqual(expected)
-}
-
-test('slug: a word', () => {
-  test_slug('word', 'word')
-})
-
-test('slug: a string', () => {
-  test_slug('basic-string', 'basic-string')
-})
-
-test('slug: a string in camel case', () => {
-  test_slug('camelCase', 'camelcase')
-})
-
-test('slug: a path', () => {
-  test_slug('path/to/something', 'path-to-something')
-})
-
-test('slug: a number', () => {
-  test_slug('4.2', '4.2')
-})
-
-test('slug: special caracter', () => {
-  test_slug('feat-(!è§-caracter', 'feat------caracter')
-})
-
-test('slug: trailing', () => {
-  test_slug('-feat-trailing-', 'feat-trailing')
-})
-
-test('slug: a very long string', () => {
-  test_slug(
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-feature-very-very-very-very-very-very-very-long-more'
-  )
-})
-
-test('slug: short string after trailing', () => {
-  test_slug(
-    '-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters-',
-    'an-awesome-feature-very-very-very-very-very-very-very-long-more'
-  )
-})
--- a/tests/slugref.test.ts
+++ b/tests/slugref.test.ts
@@ -1,45 +0,0 @@
-import {slugref} from '../src/slug'
-
-function test_slug_ref(input: string, expected: string) {
-  let actual = slugref(input)
-  expect(actual).toEqual(expected)
-}
-
-test('slug_ref:: master branch', () => {
-  test_slug_ref('refs/heads/master', 'master')
-})
-
-test('slug_ref: a feature branch', () => {
-  test_slug_ref('refs/heads/feat/new_feature', 'feat-new-feature')
-})
-
-test('slug_ref: a fix branch', () => {
-  test_slug_ref('refs/heads/fix/issue_number', 'fix-issue-number')
-})
-
-test('slug_ref: a simple tag', () => {
-  test_slug_ref('refs/tags/v1.0.0', 'v1.0.0')
-})
-
-test('slug_ref: a complex tag', () => {
-  test_slug_ref('refs/tags/product@1.0.0-rc.2', 'product-1.0.0-rc.2')
-})
-
-test('slug_ref: a reference with upper case letters', () => {
-  test_slug_ref('refs/heads/New_Awesome_Product', 'new-awesome-product')
-})
-
-test('slug_ref: test trailing', () => {
-  test_slug_ref('refs/heads/-trailing-feat-', 'trailing-feat')
-})
-
-test('slug_ref: test refs inside string', () => {
-  test_slug_ref('refs/heads/-refs/tags/feature/-', 'refs-tags-feature')
-})
-
-test('slug_ref: a very long name', () => {
-  test_slug_ref(
-    'refs/heads/an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-feature-very-very-very-very-very-very-very-long-more'
-  )
-})
--- a/tests/slugurl.test.ts
+++ b/tests/slugurl.test.ts
@@ -1,37 +0,0 @@
-import {slugurl} from '../src/slug'
-
-function test_slug_url(input: string, expected: string) {
-  let actual = slugurl(input)
-  expect(actual).toEqual(expected)
-}
-
-test('slug_url: a word', () => {
-  test_slug_url('word', 'word')
-})
-
-test('slug_url: a string', () => {
-  test_slug_url('basic-string', 'basic-string')
-})
-
-test('slug_url: a string in camel case', () => {
-  test_slug_url('camelCase', 'camelcase')
-})
-
-test('slug_url: a path', () => {
-  test_slug_url('path/to/something', 'path-to-something')
-})
-
-test('slug_url: a number', () => {
-  test_slug_url('4.2', '4-2')
-})
-
-test('slug_url: trailing', () => {
-  test_slug_url('.path.to.', 'path-to')
-})
-
-test('slug_url: a very long string', () => {
-  test_slug_url(
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-feature-very-very-very-very-very-very-very-long-more'
-  )
-})
--- a/tests/slugurlref.test.ts
+++ b/tests/slugurlref.test.ts
@@ -1,45 +0,0 @@
-import {slugurlref} from '../src/slug'
-
-function test_slug_url_ref(input: string, expected: string) {
-  let actual = slugurlref(input)
-  expect(actual).toEqual(expected)
-}
-
-test('slug_url_ref: master branch', () => {
-  test_slug_url_ref('refs/heads/master', 'master')
-})
-
-test('slug_url_ref: a feature branch', () => {
-  test_slug_url_ref('refs/heads/feat/new_feature', 'feat-new-feature')
-})
-
-test('slug_url_ref: a fix branch', () => {
-  test_slug_url_ref('refs/heads/fix/issue_number', 'fix-issue-number')
-})
-
-test('slug_url_ref: a simple tag', () => {
-  test_slug_url_ref('refs/tags/v1.0.0', 'v1-0-0')
-})
-
-test('slug_url_ref: a complex tag', () => {
-  test_slug_url_ref('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_slug_url_ref('refs/heads/New_Awesome_Product', 'new-awesome-product')
-})
-
-test('slug_url_ref: a very long name', () => {
-  test_slug_url_ref(
-    'refs/heads/an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-feature-very-very-very-very-very-very-very-long-more'
-  )
-})
-
-test('slug_url_ref: test trailing', () => {
-  test_slug_url_ref('refs/heads/-an-awesome-Feature-', 'an-awesome-feature')
-})
-
-test('slug_url_ref: test trailing with dot', () => {
-  test_slug_url_ref('refs/heads/.an-awesome-Feature.', 'an-awesome-feature')
-})
--- a/action.yml
+++ b/action.yml
@@ -1,9 +1,96 @@
 name: "GitHub Slug Action"
 description: "GitHub Action to expose slug value of environment variables inside your GitHub workflow"
-author: 'rlespinasse'
-runs:
-  using: 'node12'
-  main: 'dist/index.js'
+author: "Romain Lespinasse"
 branding:
  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
+runs:
+  using: "composite"
+  steps:
+    - run: $GITHUB_ACTION_PATH/preflight.sh
+      shell: bash
+      env:
+        INPUT_SLUG_MAXLENGTH: ${{ inputs.slug-maxlength }}
+
+    - uses: rlespinasse/slugify-value@v1.2.0
+      with:
+        key: GITHUB_REPOSITORY
+        value: ${{ github.repository }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@v1.2.0
+      with:
+        key: GITHUB_REF
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@v1.2.0
+      with:
+        key: GITHUB_HEAD_REF
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - uses: rlespinasse/slugify-value@v1.2.0
+      with:
+        key: GITHUB_BASE_REF
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+
+    # Specific values
+    - uses: rlespinasse/slugify-value@v1.2.0
+      with:
+        key: GITHUB_EVENT_REF
+        value: ${{ github.event.ref }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+
+    # Calculated values
+    - id: get-github-ref-name
+      run: echo "::set-output name=github-ref-name::$(echo "${{ github.head_ref || github.ref }}" | cut -d/ -f3)"
+      shell: bash
+    - uses: rlespinasse/slugify-value@v1.2.0
+      with:
+        key: GITHUB_REF_NAME
+        value: ${{ steps.get-github-ref-name.outputs.github-ref-name }}
+        prefix: ${{ inputs.prefix }}
+        slug-maxlength: ${{ inputs.slug-maxlength }}
+    - id: get-github-repository-owner-part
+      run: echo "::set-output name=github-repository-owner-part::$(echo $GITHUB_REPOSITORY | cut -d/ -f1)"
+      shell: bash
+    - uses: rlespinasse/slugify-value@v1.2.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: echo "::set-output name=github-repository-name-part::$(echo $GITHUB_REPOSITORY | cut -d/ -f2)"
+      shell: bash
+    - uses: rlespinasse/slugify-value@v1.2.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 }}
+
+    # Short
+    - uses: rlespinasse/shortify-git-revision@v1.4.0
+      with:
+        name: GITHUB_SHA
+        short-on-error: true
+        length: 8
+        prefix: ${{ inputs.prefix }}
+    - uses: rlespinasse/shortify-git-revision@v1.4.0
+      with:
+        name: GITHUB_EVENT_PULL_REQUEST_HEAD_SHA
+        revision: ${{ github.event.pull_request.head.sha }}
+        short-on-error: true
+        length: 8
+        prefix: ${{ inputs.prefix }}
--- a/dist/index.js
+++ b/dist/index.js
@@ -1,672 +0,0 @@
-require('./sourcemap-register.js');module.exports =
-/******/ (function(modules, runtime) { // webpackBootstrap
-/******/ 	"use strict";
-/******/ 	// The module cache
-/******/ 	var installedModules = {};
-/******/
-/******/ 	// The require function
-/******/ 	function __webpack_require__(moduleId) {
-/******/
-/******/ 		// Check if module is in cache
-/******/ 		if(installedModules[moduleId]) {
-/******/ 			return installedModules[moduleId].exports;
-/******/ 		}
-/******/ 		// Create a new module (and put it into the cache)
-/******/ 		var module = installedModules[moduleId] = {
-/******/ 			i: moduleId,
-/******/ 			l: false,
-/******/ 			exports: {}
-/******/ 		};
-/******/
-/******/ 		// Execute the module function
-/******/ 		var threw = true;
-/******/ 		try {
-/******/ 			modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
-/******/ 			threw = false;
-/******/ 		} finally {
-/******/ 			if(threw) delete installedModules[moduleId];
-/******/ 		}
-/******/
-/******/ 		// Flag the module as loaded
-/******/ 		module.l = true;
-/******/
-/******/ 		// Return the exports of the module
-/******/ 		return module.exports;
-/******/ 	}
-/******/
-/******/
-/******/ 	__webpack_require__.ab = __dirname + "/";
-/******/
-/******/ 	// the startup function
-/******/ 	function startup() {
-/******/ 		// Load entry module and return exports
-/******/ 		return __webpack_require__(109);
-/******/ 	};
-/******/
-/******/ 	// run startup
-/******/ 	return startup();
-/******/ })
-/************************************************************************/
-/******/ ({
-
-/***/ 87:
-/***/ (function(module) {
-
-module.exports = require("os");
-
-/***/ }),
-
-/***/ 109:
-/***/ (function(__unusedmodule, exports, __webpack_require__) {
-
-"use strict";
-
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const core = __importStar(__webpack_require__(186));
-const slug_1 = __webpack_require__(565);
-/**
- * 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';
-/**
- * Slugged outputs environments variables keys
- */
-const GITHUB_REPOSITORY_SLUG = 'GITHUB_REPOSITORY_SLUG';
-const GITHUB_REPOSITORY_SLUG_URL = 'GITHUB_REPOSITORY_SLUG_URL';
-const GITHUB_REF_SLUG = 'GITHUB_REF_SLUG';
-const GITHUB_HEAD_REF_SLUG = 'GITHUB_HEAD_REF_SLUG';
-const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG';
-const GITHUB_REF_SLUG_URL = 'GITHUB_REF_SLUG_URL';
-const GITHUB_HEAD_REF_SLUG_URL = 'GITHUB_HEAD_REF_SLUG_URL';
-const GITHUB_BASE_REF_SLUG_URL = 'GITHUB_BASE_REF_SLUG_URL';
-const GITHUB_SHA_SHORT = 'GITHUB_SHA_SHORT';
-const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG';
-const GITHUB_EVENT_REF_SLUG_URL = 'GITHUB_EVENT_REF_SLUG_URL';
-function run() {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const eventPath = process.env[GITHUB_EVENT_PATH];
-            if (eventPath) {
-                const eventData = yield Promise.resolve().then(() => __importStar(require(eventPath)));
-                if (eventData.hasOwnProperty('ref')) {
-                    core.exportVariable(GITHUB_EVENT_REF_SLUG, slug_1.slugref(eventData.ref));
-                    core.exportVariable(GITHUB_EVENT_REF_SLUG_URL, slug_1.slugurlref(eventData.ref));
-                }
-            }
-            exportSlug(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG);
-            exportSlugUrl(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_URL);
-            exportSlugRef(GITHUB_REF, GITHUB_REF_SLUG);
-            exportSlugRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG);
-            exportSlugRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG);
-            exportSlugUrlRef(GITHUB_REF, GITHUB_REF_SLUG_URL);
-            exportSlugUrlRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_URL);
-            exportSlugUrlRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL);
-            exportShortSha(GITHUB_SHA, GITHUB_SHA_SHORT);
-        }
-        catch (error) {
-            core.setFailed(error.message);
-        }
-    });
-}
-function exportSlug(inputKey, outputKey) {
-    const envVar = process.env[inputKey];
-    if (envVar) {
-        core.exportVariable(outputKey, slug_1.slug(envVar));
-    }
-}
-function exportSlugRef(inputKey, outputKey) {
-    const envVar = process.env[inputKey];
-    if (envVar) {
-        core.exportVariable(outputKey, slug_1.slugref(envVar));
-    }
-}
-function exportSlugUrl(inputKey, outputKey) {
-    const envVar = process.env[inputKey];
-    if (envVar) {
-        core.exportVariable(outputKey, slug_1.slugurl(envVar));
-    }
-}
-function exportSlugUrlRef(inputKey, outputKey) {
-    const envVar = process.env[inputKey];
-    if (envVar) {
-        core.exportVariable(outputKey, slug_1.slugurlref(envVar));
-    }
-}
-function exportShortSha(inputKey, outputKey) {
-    const envVar = process.env[inputKey];
-    if (envVar) {
-        core.exportVariable(outputKey, slug_1.shortsha(envVar));
-    }
-}
-run();
-
-
-/***/ }),
-
-/***/ 186:
-/***/ (function(__unusedmodule, exports, __webpack_require__) {
-
-"use strict";
-
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = __webpack_require__(351);
-const file_command_1 = __webpack_require__(717);
-const utils_1 = __webpack_require__(278);
-const os = __importStar(__webpack_require__(87));
-const path = __importStar(__webpack_require__(622));
-/**
- * The code to exit an action
- */
-var ExitCode;
-(function (ExitCode) {
-    /**
-     * A code indicating that the action was successful
-     */
-    ExitCode[ExitCode["Success"] = 0] = "Success";
-    /**
-     * A code indicating that the action was a failure
-     */
-    ExitCode[ExitCode["Failure"] = 1] = "Failure";
-})(ExitCode = exports.ExitCode || (exports.ExitCode = {}));
-//-----------------------------------------------------------------------
-// Variables
-//-----------------------------------------------------------------------
-/**
- * Sets env variable for this action and future actions in the job
- * @param name the name of the variable to set
- * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function exportVariable(name, val) {
-    const convertedVal = utils_1.toCommandValue(val);
-    process.env[name] = convertedVal;
-    const filePath = process.env['GITHUB_ENV'] || '';
-    if (filePath) {
-        const delimiter = '_GitHubActionsFileCommandDelimeter_';
-        const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`;
-        file_command_1.issueCommand('ENV', commandValue);
-    }
-    else {
-        command_1.issueCommand('set-env', { name }, convertedVal);
-    }
-}
-exports.exportVariable = exportVariable;
-/**
- * Registers a secret which will get masked from logs
- * @param secret value of the secret
- */
-function setSecret(secret) {
-    command_1.issueCommand('add-mask', {}, secret);
-}
-exports.setSecret = setSecret;
-/**
- * Prepends inputPath to the PATH (for this action and future actions)
- * @param inputPath
- */
-function addPath(inputPath) {
-    const filePath = process.env['GITHUB_PATH'] || '';
-    if (filePath) {
-        file_command_1.issueCommand('PATH', inputPath);
-    }
-    else {
-        command_1.issueCommand('add-path', {}, inputPath);
-    }
-    process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`;
-}
-exports.addPath = addPath;
-/**
- * Gets the value of an input.  The value is also trimmed.
- *
- * @param     name     name of the input to get
- * @param     options  optional. See InputOptions.
- * @returns   string
- */
-function getInput(name, options) {
-    const val = process.env[`INPUT_${name.replace(/ /g, '_').toUpperCase()}`] || '';
-    if (options && options.required && !val) {
-        throw new Error(`Input required and not supplied: ${name}`);
-    }
-    return val.trim();
-}
-exports.getInput = getInput;
-/**
- * Sets the value of an output.
- *
- * @param     name     name of the output to set
- * @param     value    value to store. Non-string values will be converted to a string via JSON.stringify
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function setOutput(name, value) {
-    command_1.issueCommand('set-output', { name }, value);
-}
-exports.setOutput = setOutput;
-/**
- * Enables or disables the echoing of commands into stdout for the rest of the step.
- * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set.
- *
- */
-function setCommandEcho(enabled) {
-    command_1.issue('echo', enabled ? 'on' : 'off');
-}
-exports.setCommandEcho = setCommandEcho;
-//-----------------------------------------------------------------------
-// Results
-//-----------------------------------------------------------------------
-/**
- * Sets the action status to failed.
- * When the action exits it will be with an exit code of 1
- * @param message add error issue message
- */
-function setFailed(message) {
-    process.exitCode = ExitCode.Failure;
-    error(message);
-}
-exports.setFailed = setFailed;
-//-----------------------------------------------------------------------
-// Logging Commands
-//-----------------------------------------------------------------------
-/**
- * Gets whether Actions Step Debug is on or not
- */
-function isDebug() {
-    return process.env['RUNNER_DEBUG'] === '1';
-}
-exports.isDebug = isDebug;
-/**
- * Writes debug message to user log
- * @param message debug message
- */
-function debug(message) {
-    command_1.issueCommand('debug', {}, message);
-}
-exports.debug = debug;
-/**
- * Adds an error issue
- * @param message error issue message. Errors will be converted to string via toString()
- */
-function error(message) {
-    command_1.issue('error', message instanceof Error ? message.toString() : message);
-}
-exports.error = error;
-/**
- * Adds an warning issue
- * @param message warning issue message. Errors will be converted to string via toString()
- */
-function warning(message) {
-    command_1.issue('warning', message instanceof Error ? message.toString() : message);
-}
-exports.warning = warning;
-/**
- * Writes info to log with console.log.
- * @param message info message
- */
-function info(message) {
-    process.stdout.write(message + os.EOL);
-}
-exports.info = info;
-/**
- * Begin an output group.
- *
- * Output until the next `groupEnd` will be foldable in this group
- *
- * @param name The name of the output group
- */
-function startGroup(name) {
-    command_1.issue('group', name);
-}
-exports.startGroup = startGroup;
-/**
- * End an output group.
- */
-function endGroup() {
-    command_1.issue('endgroup');
-}
-exports.endGroup = endGroup;
-/**
- * Wrap an asynchronous function call in a group.
- *
- * Returns the same type as the function itself.
- *
- * @param name The name of the group
- * @param fn The function to wrap in the group
- */
-function group(name, fn) {
-    return __awaiter(this, void 0, void 0, function* () {
-        startGroup(name);
-        let result;
-        try {
-            result = yield fn();
-        }
-        finally {
-            endGroup();
-        }
-        return result;
-    });
-}
-exports.group = group;
-//-----------------------------------------------------------------------
-// Wrapper action state
-//-----------------------------------------------------------------------
-/**
- * Saves state for current action, the state can only be retrieved by this action's post job execution.
- *
- * @param     name     name of the state to store
- * @param     value    value to store. Non-string values will be converted to a string via JSON.stringify
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-function saveState(name, value) {
-    command_1.issueCommand('save-state', { name }, value);
-}
-exports.saveState = saveState;
-/**
- * Gets the value of an state set by this action's main execution.
- *
- * @param     name     name of the state to get
- * @returns   string
- */
-function getState(name) {
-    return process.env[`STATE_${name}`] || '';
-}
-exports.getState = getState;
-//# sourceMappingURL=core.js.map
-
-/***/ }),
-
-/***/ 278:
-/***/ (function(__unusedmodule, exports) {
-
-"use strict";
-
-// We use any as a valid input type
-/* eslint-disable @typescript-eslint/no-explicit-any */
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Sanitizes an input into a string so it can be passed into issueCommand safely
- * @param input input to sanitize into a string
- */
-function toCommandValue(input) {
-    if (input === null || input === undefined) {
-        return '';
-    }
-    else if (typeof input === 'string' || input instanceof String) {
-        return input;
-    }
-    return JSON.stringify(input);
-}
-exports.toCommandValue = toCommandValue;
-//# sourceMappingURL=utils.js.map
-
-/***/ }),
-
-/***/ 351:
-/***/ (function(__unusedmodule, exports, __webpack_require__) {
-
-"use strict";
-
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const os = __importStar(__webpack_require__(87));
-const utils_1 = __webpack_require__(278);
-/**
- * Commands
- *
- * Command Format:
- *   ::name key=value,key=value::message
- *
- * Examples:
- *   ::warning::This is the message
- *   ::set-env name=MY_VAR::some value
- */
-function issueCommand(command, properties, message) {
-    const cmd = new Command(command, properties, message);
-    process.stdout.write(cmd.toString() + os.EOL);
-}
-exports.issueCommand = issueCommand;
-function issue(name, message = '') {
-    issueCommand(name, {}, message);
-}
-exports.issue = issue;
-const CMD_STRING = '::';
-class Command {
-    constructor(command, properties, message) {
-        if (!command) {
-            command = 'missing.command';
-        }
-        this.command = command;
-        this.properties = properties;
-        this.message = message;
-    }
-    toString() {
-        let cmdStr = CMD_STRING + this.command;
-        if (this.properties && Object.keys(this.properties).length > 0) {
-            cmdStr += ' ';
-            let first = true;
-            for (const key in this.properties) {
-                if (this.properties.hasOwnProperty(key)) {
-                    const val = this.properties[key];
-                    if (val) {
-                        if (first) {
-                            first = false;
-                        }
-                        else {
-                            cmdStr += ',';
-                        }
-                        cmdStr += `${key}=${escapeProperty(val)}`;
-                    }
-                }
-            }
-        }
-        cmdStr += `${CMD_STRING}${escapeData(this.message)}`;
-        return cmdStr;
-    }
-}
-function escapeData(s) {
-    return utils_1.toCommandValue(s)
-        .replace(/%/g, '%25')
-        .replace(/\r/g, '%0D')
-        .replace(/\n/g, '%0A');
-}
-function escapeProperty(s) {
-    return utils_1.toCommandValue(s)
-        .replace(/%/g, '%25')
-        .replace(/\r/g, '%0D')
-        .replace(/\n/g, '%0A')
-        .replace(/:/g, '%3A')
-        .replace(/,/g, '%2C');
-}
-//# sourceMappingURL=command.js.map
-
-/***/ }),
-
-/***/ 565:
-/***/ (function(__unusedmodule, exports) {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.shortsha = exports.slugurlref = exports.slugurl = exports.slugref = exports.slug = void 0;
-const MAX_SLUG_STRING_SIZE = 63;
-const SHORT_SHA_SIZE = 8;
-/**
- * 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 and trailing `-` character
- * - limit the string size to 63 characters
- * @param envVar to be slugged
- */
-function slug(envVar) {
-    return trailHyphen(replaceAnyNonAlphanumericCaracter(envVar.toLowerCase())).substring(0, MAX_SLUG_STRING_SIZE);
-}
-exports.slug = slug;
-/**
- * slug will take envVar and then :
- * - remove refs/(heads|tags)/
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`, and `.`
- * - remove leading and trailing `-` character
- * - limit the string size to 63 characters
- * @param envVar to be slugged
- */
-function slugref(envVar) {
-    return slug(removeRef(envVar.toLowerCase()));
-}
-exports.slugref = slugref;
-/**
- * slug will take envVar and then :
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading and trailing `-` character
- * - limit the string size to 63 characters
- * @param envVar to be slugged
- */
-function slugurl(envVar) {
-    return slug(replaceAnyDotToHyphen(envVar));
-}
-exports.slugurl = slugurl;
-/**
- * slug will take envVar and then :
- * - remove refs/(heads|tags)/
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading and trailing `-` character
- * - limit the string size to 63 characters
- * @param envVar to be slugged
- */
-function slugurlref(envVar) {
-    return slugurl(slugref(envVar));
-}
-exports.slugurlref = slugurlref;
-/**
- * slug will take envVar and then :
- * - limit the string size to 8 characters
- * @param envVar to be slugged
- */
-function shortsha(envVar) {
-    return envVar.substring(0, SHORT_SHA_SIZE);
-}
-exports.shortsha = shortsha;
-function trailHyphen(envVar) {
-    return envVar.replace(RegExp('^-*', 'g'), '').replace(RegExp('-*$', 'g'), '');
-}
-function replaceAnyNonAlphanumericCaracter(envVar) {
-    return envVar.replace(RegExp('[^a-z0-9.]', 'g'), '-');
-}
-function replaceAnyDotToHyphen(envVar) {
-    return envVar.replace(RegExp('[.]', 'g'), '-');
-}
-function removeRef(envVar) {
-    return envVar.replace(RegExp('^refs/(heads|tags)/'), '');
-}
-
-
-/***/ }),
-
-/***/ 622:
-/***/ (function(module) {
-
-module.exports = require("path");
-
-/***/ }),
-
-/***/ 717:
-/***/ (function(__unusedmodule, exports, __webpack_require__) {
-
-"use strict";
-
-// For internal use, subject to change.
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-// We use any as a valid input type
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const fs = __importStar(__webpack_require__(747));
-const os = __importStar(__webpack_require__(87));
-const utils_1 = __webpack_require__(278);
-function issueCommand(command, message) {
-    const filePath = process.env[`GITHUB_${command}`];
-    if (!filePath) {
-        throw new Error(`Unable to find environment variable for file command ${command}`);
-    }
-    if (!fs.existsSync(filePath)) {
-        throw new Error(`Missing file at path: ${filePath}`);
-    }
-    fs.appendFileSync(filePath, `${utils_1.toCommandValue(message)}${os.EOL}`, {
-        encoding: 'utf8'
-    });
-}
-exports.issueCommand = issueCommand;
-//# sourceMappingURL=file-command.js.map
-
-/***/ }),
-
-/***/ 747:
-/***/ (function(module) {
-
-module.exports = require("fs");
-
-/***/ })
-
-/******/ });
-//# sourceMappingURL=index.js.map
--- a/dist/index.js.map
+++ b/dist/index.js.map
--- a/dist/sourcemap-register.js
+++ b/dist/sourcemap-register.js
--- a/docs/github-variables.md
+++ b/docs/github-variables.md
@@ -0,0 +1,96 @@
+# 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
--- a/docs/partial-variables.md
+++ b/docs/partial-variables.md
@@ -0,0 +1,28 @@
+# 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              |
--- a/docs/short-variables.md
+++ b/docs/short-variables.md
@@ -0,0 +1,27 @@
+# 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                                 |
--- a/docs/slug-url-variables.md
+++ b/docs/slug-url-variables.md
@@ -0,0 +1,109 @@
+# 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
--- a/docs/slug-variables.md
+++ b/docs/slug-variables.md
@@ -0,0 +1,105 @@
+# 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
--- a/examples/linux-usage.yml
+++ b/examples/linux-usage.yml
@@ -0,0 +1,34 @@
+name: Linux usage
+
+on: push
+
+jobs:
+  usage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: rlespinasse/github-slug-action@v4
+      - name: Output
+        run: |
+          echo "Partial variables"
+          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART }}"
+          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART }}"
+          echo "Slug variables"
+          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 }}"
+          echo "Slug URL variables"
+          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 }}"
+          echo "Short SHA variables"
+          echo "   sha                 : ${{ env.GITHUB_SHA_SHORT }}"
+          echo "   pull request sha    : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
--- a/examples/macos-usage.yml
+++ b/examples/macos-usage.yml
@@ -0,0 +1,34 @@
+name: MacOS usage
+
+on: push
+
+jobs:
+  usage:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: rlespinasse/github-slug-action@v4
+      - name: Output
+        run: |
+          echo "Partial variables"
+          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART }}"
+          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART }}"
+          echo "Slug variables"
+          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 }}"
+          echo "Slug URL variables"
+          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 }}"
+          echo "Short SHA variables"
+          echo "   sha                 : ${{ env.GITHUB_SHA_SHORT }}"
+          echo "   pull request sha    : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
--- a/examples/url-use.yml
+++ b/examples/url-use.yml
@@ -0,0 +1,20 @@
+name: URL use
+
+on: push
+
+jobs:
+  as_subdomain:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: rlespinasse/github-slug-action@v4
+      - run: |
+          ./deploy-application.sh --url "https://${{ env.GITHUB_REF_SLUG_URL }}.staging.app.example.com"
+
+  as_resource_path:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: rlespinasse/github-slug-action@v4
+      - run: |
+          ./deploy-application.sh --url "https://staging.app.example.com/${{ env.GITHUB_REF_SLUG_URL }}"
--- a/examples/windows-usage.yml
+++ b/examples/windows-usage.yml
@@ -0,0 +1,34 @@
+name: Windows usage
+
+on: push
+
+jobs:
+  usage:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: rlespinasse/github-slug-action@v4
+      - name: Output
+        run: |
+          echo "Partial variables"
+          echo "   repository owner    : $env:GITHUB_REPOSITORY_OWNER_PART"
+          echo "   repository name     : $env:GITHUB_REPOSITORY_NAME_PART"
+          echo "Slug variables"
+          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"
+          echo "Slug URL variables"
+          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"
+          echo "Short SHA variables"
+          echo "   sha                 : $env:GITHUB_SHA_SHORT"
+          echo "   pull request sha    : $env:GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT"
--- a/jest.config.js
+++ b/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
-}
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,63 +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": "http://github.com/rlespinasse/github-slug-action.git"
-  },
-  "keywords": [
-    "actions",
-    "node",
-    "setup"
-  ],
-  "author": "rlespinasse",
-  "dependencies": {
-    "@actions/core": "^1.2.6"
-  },
-  "devDependencies": {
-    "@semantic-release/changelog": "5.0.1",
-    "@semantic-release/git": "9.0.0",
-    "@types/jest": "^26.0.15",
-    "@types/node": "^14.14.3",
-    "@typescript-eslint/parser": "^3.9.1",
-    "@vercel/ncc": "^0.23.0",
-    "eslint": "^7.12.0",
-    "eslint-plugin-github": "^4.1.1",
-    "eslint-plugin-jest": "^23.20.0",
-    "jest": "^26.6.1",
-    "jest-circus": "^26.6.1",
-    "js-yaml": "^3.14.0",
-    "prettier": "2.0.5",
-    "semantic-release": "17.0.7",
-    "ts-jest": "^26.4.2",
-    "typescript": "^3.9.7"
-  },
-  "release": {
-    "tagFormat": "${version}",
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/changelog",
-      "@semantic-release/git",
-      "@semantic-release/github"
-    ],
-    "branches": [
-      "v2.x",
-      "v3.x"
-    ]
-  }
-}
--- a/preflight.sh
+++ b/preflight.sh
@@ -0,0 +1,9 @@
+#!/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
--- a/src/main.ts
+++ b/src/main.ts
@@ -1,97 +0,0 @@
-import * as core from '@actions/core'
-import {slugref, slug, slugurl, slugurlref, shortsha} from './slug'
-
-/**
- * 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'
-
-/**
- * Slugged outputs environments variables keys
- */
-const GITHUB_REPOSITORY_SLUG = 'GITHUB_REPOSITORY_SLUG'
-const GITHUB_REPOSITORY_SLUG_URL = 'GITHUB_REPOSITORY_SLUG_URL'
-const GITHUB_REF_SLUG = 'GITHUB_REF_SLUG'
-const GITHUB_HEAD_REF_SLUG = 'GITHUB_HEAD_REF_SLUG'
-const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG'
-const GITHUB_REF_SLUG_URL = 'GITHUB_REF_SLUG_URL'
-const GITHUB_HEAD_REF_SLUG_URL = 'GITHUB_HEAD_REF_SLUG_URL'
-const GITHUB_BASE_REF_SLUG_URL = 'GITHUB_BASE_REF_SLUG_URL'
-const GITHUB_SHA_SHORT = 'GITHUB_SHA_SHORT'
-const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG'
-const GITHUB_EVENT_REF_SLUG_URL = 'GITHUB_EVENT_REF_SLUG_URL'
-
-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_URL,
-          slugurlref(eventData.ref)
-        )
-      }
-    }
-
-    exportSlug(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG)
-
-    exportSlugUrl(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_URL)
-
-    exportSlugRef(GITHUB_REF, GITHUB_REF_SLUG)
-    exportSlugRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG)
-    exportSlugRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG)
-
-    exportSlugUrlRef(GITHUB_REF, GITHUB_REF_SLUG_URL)
-    exportSlugUrlRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_URL)
-    exportSlugUrlRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL)
-
-    exportShortSha(GITHUB_SHA, GITHUB_SHA_SHORT)
-  } catch (error) {
-    core.setFailed(error.message)
-  }
-}
-
-function exportSlug(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, slug(envVar))
-  }
-}
-
-function exportSlugRef(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, slugref(envVar))
-  }
-}
-
-function exportSlugUrl(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, slugurl(envVar))
-  }
-}
-
-function exportSlugUrlRef(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, slugurlref(envVar))
-  }
-}
-
-function exportShortSha(inputKey: string, outputKey: string): void {
-  const envVar = process.env[inputKey]
-  if (envVar) {
-    core.exportVariable(outputKey, shortsha(envVar))
-  }
-}
-
-run()
--- a/src/slug.ts
+++ b/src/slug.ts
@@ -1,79 +0,0 @@
-const MAX_SLUG_STRING_SIZE = 63
-const SHORT_SHA_SIZE = 8
-
-/**
- * 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 and trailing `-` character
- * - limit the string size to 63 characters
- * @param envVar to be slugged
- */
-export function slug(envVar: string): string {
-  return trailHyphen(
-    replaceAnyNonAlphanumericCaracter(envVar.toLowerCase())
-  ).substring(0, MAX_SLUG_STRING_SIZE)
-}
-
-/**
- * slug will take envVar and then :
- * - remove refs/(heads|tags)/
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`, and `.`
- * - remove leading and trailing `-` character
- * - limit the string size to 63 characters
- * @param envVar to be slugged
- */
-export function slugref(envVar: string): string {
-  return slug(removeRef(envVar.toLowerCase()))
-}
-
-/**
- * slug will take envVar and then :
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading and trailing `-` character
- * - limit the string size to 63 characters
- * @param envVar to be slugged
- */
-export function slugurl(envVar: string): string {
-  return slug(replaceAnyDotToHyphen(envVar))
-}
-
-/**
- * slug will take envVar and then :
- * - remove refs/(heads|tags)/
- * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading and trailing `-` character
- * - limit the string size to 63 characters
- * @param envVar to be slugged
- */
-export function slugurlref(envVar: string): string {
-  return slugurl(slugref(envVar))
-}
-
-/**
- * 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)
-}
-
-function trailHyphen(envVar: string): string {
-  return envVar.replace(RegExp('^-*', 'g'), '').replace(RegExp('-*$', 'g'), '')
-}
-
-function replaceAnyNonAlphanumericCaracter(envVar: string): string {
-  return envVar.replace(RegExp('[^a-z0-9.]', 'g'), '-')
-}
-
-function replaceAnyDotToHyphen(envVar: string): string {
-  return envVar.replace(RegExp('[.]', 'g'), '-')
-}
-
-function removeRef(envVar: string): string {
-  return envVar.replace(RegExp('^refs/(heads|tags)/'), '')
-}
--- a/tsconfig.json
+++ b/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"]
-}
Author	SHA1	Message	Date
Romain Lespinasse	88f3ee8f6f	feat: add option to set a different slug length than 63	2022-03-19 22:50:08 +01:00
rlespinasse	cd9871b66e	fix(short): populate GITHUB_SHA_SHORT correctly	2022-03-19 11:35:00 +01:00
Romain Lespinasse	1fb0eeb01e	docs(readme): reword troubleshooting section	2022-01-01 15:15:35 +01:00
Romain Lespinasse	bd31a9f564	docs(security): add end of life of branch section	2022-01-01 15:06:51 +01:00
Romain Lespinasse	78ed3f92ee	ci: enable v4.x release	2022-01-01 14:23:29 +01:00
rlespinasse	c1ec67827c	ci: build and release Also the test part compare v3.x and v4.x exported variables (when it's possible to do so).	2022-01-01 14:17:59 +01:00
rlespinasse	e91720375f	feat: support prefix on exported variables	2022-01-01 14:17:59 +01:00
rlespinasse	e13c7fcc34	refactor: remove all node related files	2022-01-01 14:17:59 +01:00
rlespinasse	4405613430	feat: use composite action instead of node Using composite with two actions: - rlespinasse/slugify-value for the SLUG features - rlespinasse/shortify-git-revision for the SHORT feature Since the SHORT sha is now based on a shorted git revision, and no more on a fix substring. BREAKING CHANGE: use different backend for the action	2022-01-01 14:17:59 +01:00
rlespinasse	5d786b4cd2	docs(security): remove support of v2.x branch	2022-01-01 14:17:59 +01:00
rlespinasse	ba2cfdae8a	docs: use v4.x references	2022-01-01 14:17:59 +01:00
rlespinasse	200b9d942b	ci: prepare v4.x release branch	2021-12-05 00:27:10 +01:00
rlespinasse	046be07299	build: fix npm vulnerabilities	2021-12-04 22:00:29 +01:00
rlespinasse	38b80287e3	ci: use matrix for os testing	2021-12-04 21:26:47 +01:00
Romain Lespinasse	c559dac9da	docs(example): use dedictated domain exemple name	2021-10-30 09:25:40 +02:00
Romain Lespinasse	2f05f8b5cb	docs(readme): add Michael Heap article	2021-09-29 16:29:38 +02:00
dependabot[bot]	9f53b89c13	build(deps): bump semver-regex from 3.1.2 to 3.1.3	2021-09-21 17:12:59 +02:00
semantic-release-bot	172fe43594	chore(release): 3.6.0 [skip ci] # [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`](`12a7510630`))	2021-09-15 15:01:24 +00:00
Antoine Méausoone	12a7510630	feat: add GITHUB_REF_NAME env var GITHUB_REF_NAME will contain the reference name (branch or tag) - based on GITHUB_HEAD_REF in a pull-request event context, - based on GITHUB_REF in others event contexts.	2021-09-15 17:00:11 +02:00
rlespinasse	b71a8a1cbc	build: fix potential security vulnerabilities	2021-09-02 21:56:17 +02:00
Joshua Chaitin-Pollak	54910e921d	docs: minor grammatical fixes for clarity	2021-08-04 23:07:16 +02:00
rlespinasse	35d90c4a71	build: update transitive dependencies	2021-06-14 22:44:11 +02:00
rlespinasse	ada34a0888	docs: fix link to use by badge	2021-04-17 23:19:39 +02:00
rlespinasse	6370faccb7	docs: improve links	2021-04-17 23:16:44 +02:00
rlespinasse	81beb28f90	ci: improve release process	2021-04-17 22:16:49 +02:00
Romain Lespinasse	08cd74e0fa	docs: improve overview section	2021-04-17 22:16:49 +02:00
Romain Lespinasse	8c0a3268b6	docs: improve overview section	2021-04-02 16:14:40 +02:00
semantic-release-bot	016823880d	chore(release): 3.5.1 [skip ci] ## [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`](`e6c550f88c`))	2021-03-31 06:58:56 +00:00
Mark Allen	e6c550f88c	fix: update dist files	2021-03-31 08:57:45 +02:00
semantic-release-bot	4060fda269	chore(release): 3.5.0 [skip ci] # [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`](`475d293680`))	2021-03-30 20:05:12 +00:00
Mark Allen	475d293680	feat: allow underscore in slug values	2021-03-30 22:04:00 +02:00
semantic-release-bot	0c099abd97	chore(release): 3.4.0 [skip ci] # [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`](`6c93fcbf53`))	2021-03-02 23:30:23 +00:00
rlespinasse	6c93fcbf53	feat: add _CS suffix to keep value case-sensitive	2021-03-03 00:29:09 +01:00
rlespinasse	38c43d3f60	build(node): use non-vulnerable version of marked	2021-02-27 22:37:18 +01:00
rlespinasse	275eb0d01d	docs(slug): document pull_request slug issue	2021-01-27 19:31:46 +01:00
semantic-release-bot	d1880ea5b3	chore(release): 3.3.0 [skip ci] # [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`](`78985f84ec`)) ### Features * support partial GITHUB_REPOSITORY ([`75ce03b`](`75ce03b6a0`))	2021-01-25 22:20:39 +00:00
rlespinasse	66299f72e4	docs: improve readability on tables	2021-01-25 23:16:23 +01:00
rlespinasse	78985f84ec	fix: support pull-request for slug and slug url	2021-01-25 22:12:27 +01:00
rlespinasse	75ce03b6a0	feat: support partial GITHUB_REPOSITORY	2021-01-25 22:12:27 +01:00
rlespinasse	49e1056c70	docs(troubleshooting): add naming convention issue	2021-01-25 20:01:05 +01:00
rlespinasse	81bff0391a	docs(README): expose documentation and examples	2021-01-25 20:01:05 +01:00
rlespinasse	b956e16ac2	ci: print better testing output	2021-01-25 20:01:05 +01:00
rlespinasse	fad587c035	build: update dependencies	2021-01-25 20:01:05 +01:00
Romain Lespinasse	5f4806451f	ci: disable linter about standard js Since we use Prettier instead	2021-01-12 10:24:06 +01:00
semantic-release-bot	c8d8ee50d0	chore(release): 3.2.0 [skip ci] # [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`](`5b9fe6015d`))	2021-01-12 09:23:14 +00:00
Julien Klaer	5b9fe6015d	feat: expose GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT	2021-01-12 10:22:14 +01:00
rlespinasse	5629d21ee9	ci(linter): use repo eslint configuration	2021-01-09 09:44:25 +01:00
dependabot[bot]	b6938fb2bd	build(deps): bump node-notifier from 8.0.0 to 8.0.1 Bumps [node-notifier](https://github.com/mikaelbr/node-notifier) from 8.0.0 to 8.0.1. - [Release notes](https://github.com/mikaelbr/node-notifier/releases) - [Changelog](https://github.com/mikaelbr/node-notifier/blob/v8.0.1/CHANGELOG.md) - [Commits](https://github.com/mikaelbr/node-notifier/compare/v8.0.0...v8.0.1) Signed-off-by: dependabot[bot] <support@github.com>	2021-01-01 18:42:36 +01:00
Romain Lespinasse	d6257a36a9	docs(contributing): fix typo	2020-12-18 17:39:27 +01:00
dependabot[bot]	7ad978282a	build(deps): bump ini from 1.3.5 to 1.3.8 Bumps [ini](https://github.com/isaacs/ini) from 1.3.5 to 1.3.8. - [Release notes](https://github.com/isaacs/ini/releases) - [Commits](https://github.com/isaacs/ini/compare/v1.3.5...v1.3.8) Signed-off-by: dependabot[bot] <support@github.com>	2020-12-14 08:32:50 +01:00
Romain Lespinasse	9f5fafb8ad	docs: add talks/articles section	2020-12-12 18:13:01 +01:00
Romain Lespinasse	750d2f7f48	ci: setup CodeQL GitHub workflow	2020-12-05 19:37:21 +01:00
Alain Hélaïli	2b1034b1fb	docs: fix typo in sample	2020-12-05 15:27:19 +01:00
dependabot[bot]	1b1913be6c	build(deps-dev): bump semantic-release from 17.0.7 to 17.2.3 Bumps [semantic-release](https://github.com/semantic-release/semantic-release) from 17.0.7 to 17.2.3. - [Release notes](https://github.com/semantic-release/semantic-release/releases) - [Commits](https://github.com/semantic-release/semantic-release/compare/v17.0.7...v17.2.3) Signed-off-by: dependabot[bot] <support@github.com>	2020-11-19 12:59:57 +01:00
Romain Lespinasse	cc560ad7b4	ci: run linter on default branch	2020-11-01 21:31:23 +01:00
rlespinasse	549c11b4e2	ci: improve build workflow	2020-11-01 21:29:52 +01:00
rlespinasse	68eb43656c	ci: add dependabot for github-actions	2020-11-01 21:29:52 +01:00
rlespinasse	2aba10a826	ci: add linter workflow	2020-11-01 21:29:52 +01:00
Romain Lespinasse	afcda09378	docs(readme): add license badge	2020-11-01 21:01:37 +01:00
Romain Lespinasse	15f6edebdd	docs(readme): improve action scope	2020-11-01 20:52:34 +01:00