chore(release): 3.6.1 [skip ci]

## [3.6.1](https://github.com/rlespinasse/github-slug-action/compare/3.6.0...3.6.1) (2022-08-22)

### Bug Fixes

* remove trailing hyphens if any after cut ([19f9c84](19f9c84ac6))

.github/workflows/build.yml

@@ -1,131 +0,0 @@
-name: Build
-
-on:
-  push:
-    branches:
-      - v3.x
-  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.3.4
-          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  }}
-
-  os-test:
-    runs-on: ${{ matrix.os  }}
-    strategy:
-      matrix:
-        os:
-          - ubuntu-latest
-          - macos-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ./
-      - 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 }}"
-      - name: Case Sensitive Output
-        run: |
-          echo "Slug variables"
-          echo "   repository          : ${{ env.GITHUB_REPOSITORY_SLUG_CS }}"
-          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}"
-          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}"
-          echo "   ref                 : ${{ env.GITHUB_REF_SLUG_CS }}"
-          echo "   head ref            : ${{ env.GITHUB_HEAD_REF_SLUG_CS }}"
-          echo "   base ref            : ${{ env.GITHUB_BASE_REF_SLUG_CS }}"
-          echo "   event ref           : ${{ env.GITHUB_EVENT_REF_SLUG_CS }}"
-          echo "Slug URL variables"
-          echo "   repository          : ${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}"
-          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}"
-          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}"
-          echo "   ref                 : ${{ env.GITHUB_REF_SLUG_URL_CS }}"
-          echo "   head ref            : ${{ env.GITHUB_HEAD_REF_SLUG_URL_CS }}"
-          echo "   base ref            : ${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}"
-          echo "   event ref           : ${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}"
-
-  win-test:
-    runs-on: windows-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ./
-      - 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"
-      - name: Case Sensitive Output
-        run: |
-          echo "Slug variables"
-          echo "   repository          : $env:GITHUB_REPOSITORY_SLUG_CS"
-          echo "   repository owner    : $env:GITHUB_REPOSITORY_OWNER_PART_SLUG_CS"
-          echo "   repository name     : $env:GITHUB_REPOSITORY_NAME_PART_SLUG_CS"
-          echo "   ref                 : $env:GITHUB_REF_SLUG_CS"
-          echo "   head ref            : $env:GITHUB_HEAD_REF_SLUG_CS"
-          echo "   base ref            : $env:GITHUB_BASE_REF_SLUG_CS"
-          echo "   event ref           : $env:GITHUB_EVENT_REF_SLUG_CS"
-          echo "Slug URL variables"
-          echo "   repository          : $env:GITHUB_REPOSITORY_SLUG_URL_CS"
-          echo "   repository owner    : $env:GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS"
-          echo "   repository name     : $env:GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS"
-          echo "   ref                 : $env:GITHUB_REF_SLUG_URL_CS"
-          echo "   head ref            : $env:GITHUB_HEAD_REF_SLUG_URL_CS"
-          echo "   base ref            : $env:GITHUB_BASE_REF_SLUG_URL_CS"
-          echo "   event ref           : $env:GITHUB_EVENT_REF_SLUG_URL_CS"

.github/workflows/codeql-analysis.yml

@@ -1,34 +1,28 @@
-name: "CodeQL"
+name: '[v3] CodeQL'
 
 on:
   push:
-    branches: [ v3.x, v*.x ]
+    branches:
+      - v3.x
   pull_request:
-    branches: [ v3.x ]
+    branches:
+      - v3.x
   schedule:
     - cron: '0 6 * * 1'
 
 jobs:
-  analyze:
-    name: Analyze
+  analyse:
+    name: analyze
     runs-on: ubuntu-latest
-
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
-
+        language: ['javascript']
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v2
-
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
-      with:
-        languages: ${{ matrix.language }}
-
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      - uses: technote-space/auto-cancel-redundant-workflow@v1
+      - uses: actions/checkout@v3
+      - uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+      - uses: github/codeql-action/autobuild@v1
+      - uses: github/codeql-action/analyze@v1

.github/workflows/github-slug.yml

@@ -0,0 +1,72 @@
+name: '[v3] Testing'
+on: [push]
+jobs:
+  github-slug-on-os:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - run: npm install
+      - run: npm run all
+      - uses: ./
+      - name: Partial variables
+        run: |
+          echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART }}"
+          echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART }}"
+        shell: bash
+      - name: Slug variables
+        run: |
+          echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG }}"
+          echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG }}"
+          echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG }}"
+          echo "ref              : ${{ env.GITHUB_REF_SLUG }}"
+          echo "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG }}"
+          echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG }}"
+          echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG }}"
+      - name: Slug variables (Case Sensitive)
+        run: |
+          echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG_CS }}"
+          echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}"
+          echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}"
+          echo "ref              : ${{ env.GITHUB_REF_SLUG_CS }}"
+          echo "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG_CS }}"
+          echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG_CS }}"
+          echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG_CS }}"
+        shell: bash
+      - name: Slug URL variables
+        run: |
+          echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG_URL }}"
+          echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}"
+          echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}"
+          echo "ref              : ${{ env.GITHUB_REF_SLUG_URL }}"
+          echo "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG_URL }}"
+          echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG_URL }}"
+          echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG_URL }}"
+        shell: bash
+      - name: Slug URL variables (Case Sensitive)
+        run: |
+          echo "repository       : ${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}"
+          echo "repository owner : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}"
+          echo "repository name  : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}"
+          echo "ref              : ${{ env.GITHUB_REF_SLUG_URL_CS }}"
+          echo "head ref         : ${{ env.GITHUB_HEAD_REF_SLUG_URL_CS }}"
+          echo "base ref         : ${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}"
+          echo "event ref        : ${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}"
+        shell: bash
+      - name: Ref Name
+        run: |
+          echo "raw                       : ${{ env.GITHUB_REF_NAME }}"
+          echo "slug                      : ${{ env.GITHUB_REF_NAME_SLUG }}"
+          echo "slug url                  : ${{ env.GITHUB_REF_NAME_SLUG_URL }}"
+          echo "slug (Case Sensitive)     : ${{ env.GITHUB_REF_NAME_SLUG_CS }}"
+          echo "slug url (Case Sensitive) : ${{ env.GITHUB_REF_NAME_SLUG_URL_CS }}"
+        shell: bash
+      - name: Short SHA variables
+        run: |
+          echo "sha              : ${{ env.GITHUB_SHA_SHORT }}"
+          echo "pull request sha : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
+        shell: bash

.github/workflows/linter.yml

@@ -1,31 +0,0 @@
-name: Lint
-
-on:
-  push:
-    branches:
-      - v3.x
-  pull_request:
-
-jobs:
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-
-      - name: Lint Code Base
-        uses: github/super-linter@v3
-        env:
-          VALIDATE_ALL_CODEBASE: false
-          VALIDATE_JAVASCRIPT_STANDARD: false
-          VALIDATE_TYPESCRIPT_STANDARD: false
-          LINTER_RULES_PATH: .
-          JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json
-          JAVASCRIPT_DEFAULT_STYLE: prettier
-          DEFAULT_BRANCH: v3.x
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          FILTER_REGEX_INCLUDE: .*src/.*

.github/workflows/release-dryrun.yml

@@ -0,0 +1,25 @@
+name: '[v3] Release DryRun'
+
+on:
+  push:
+    branches-ignore:
+      - v*.x
+
+jobs:
+  release-dryrun:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: technote-space/auto-cancel-redundant-workflow@v1
+      - uses: actions/checkout@v3
+      - run: npm install
+      - run: npm run all
+      - uses: ./
+      - uses: cycjimmy/semantic-release-action@v3
+        with:
+          branches: |
+            [
+              "${{ env.GITHUB_REF_NAME }}"
+            ]
+          dry_run: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: '[v3] Release'
+
+on:
+  push:
+    branches:
+      - v*.x
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: technote-space/auto-cancel-redundant-workflow@v1
+      - uses: actions/checkout@v3
+      - run: npm install
+      - run: npm run all
+      - uses: cycjimmy/semantic-release-action@v3
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -1,3 +1,24 @@
+## [3.6.1](https://github.com/rlespinasse/github-slug-action/compare/3.6.0...3.6.1) (2022-08-22)
+
+
+### Bug Fixes
+
+* remove trailing hyphens if any after cut ([19f9c84](https://github.com/rlespinasse/github-slug-action/commit/19f9c84ac61b17071a3cfc4ae984ac0e2ba1cdae))
+
+# [3.6.0](http://github.com/rlespinasse/github-slug-action/compare/3.5.1...3.6.0) (2021-09-15)
+
+
+### Features
+
+* add GITHUB_REF_NAME env var ([12a7510](http://github.com/rlespinasse/github-slug-action/commit/12a75106304d45442301df66d3ba38e1ac002649))
+
+## [3.5.1](http://github.com/rlespinasse/github-slug-action/compare/3.5.0...3.5.1) (2021-03-31)
+
+
+### Bug Fixes
+
+* update dist files ([e6c550f](http://github.com/rlespinasse/github-slug-action/commit/e6c550f88ccca52a82675b89186b6b72864f087c))
+
 # [3.5.0](http://github.com/rlespinasse/github-slug-action/compare/3.4.0...3.5.0) (2021-03-30)
 
 

CONTRIBUTING.md

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

DEVELOPERS.md

@@ -1,11 +1,15 @@
 # Developers guide
 
+## Prepare
+
 Install the dependencies
 
 ```bash
 npm install
 ```
 
+## Develop
+
 Build the typescript and package it for distribution
 
 ```bash
@@ -24,3 +28,11 @@ $ npm test
 
 ...
 ```
+
+## Contribute
+
+Before creating a commit, validate your changes and build the associated distribution files
+
+```bash
+npm run all
+```

README.md

@@ -1,11 +1,10 @@
 # GitHub Slug action
 
-[![Actions Status][1]][2]
-![GitHub Super-Linter][13]
-[![Public workflows that use this action.][8]][9]
-[![Licence][11]][12]
+[![Release][release-badge]][releases]
+![Lint][lint-badge]
+[![Licence][license-badge]][license]
 
-This GitHub Action will expose the slug/short values of [some GitHub environment variables][10] inside your GitHub workflow.
+This GitHub Action will expose the slug/short values of [some GitHub environment variables][default-environment-variables] inside your GitHub workflow.
 
 ## Table of Contents
 
@@ -14,13 +13,16 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
   - [Overview](#overview)
   - [Use this action](#use-this-action)
   - [Available Environment variables](#available-environment-variables)
+    - [Enhanced variables](#enhanced-variables)
     - [Partial variables](#partial-variables)
     - [Slug variables](#slug-variables)
     - [Slug URL variables](#slug-url-variables)
     - [Short variables](#short-variables)
   - [Contribute](#contribute)
   - [Troubleshooting](#troubleshooting)
-    - [One of environement variable don't work as intended](#one-of-environement-variable-dont-work-as-intended)
+    - [One of the environment variables doesn't work as intended](#one-of-the-environment-variables-doesnt-work-as-intended)
+      - [Known environment variable conflicts](#known-environment-variable-conflicts)
+        - [GITHUB_REF_NAME](#github_ref_name)
     - [An action could not be found at the URI](#an-action-could-not-be-found-at-the-uri)
   - [Thanks for talking about us](#thanks-for-talking-about-us)
 
@@ -30,21 +32,28 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
 
 - put the variable content in lower case
 - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
-- remove leading and trailing `-` character
+- remove leading `-` characters
 - limit the string size to 63 characters
+- remove trailing `-` characters
 
 <details>
   <summary>Others <b>Slug-ish</b> commands are available</summary>
   <p>
 
-- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL (Like `SLUG` but `.` is also replaced by `-`)
-- `SHORT` on a variable will limit the string size to 8 characters (useful for _sha_ value)
+- `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
-_ `<VAR>_CS` on others variables to keep the value case-sensitive
+  - Like `GITHUB_REPOSITORY_OWNER_PART` for the owner part of `GITHUB_REPOSITORY`
+- `<VAR>_CS` on others variables to keep the value case-sensitive
+  - Like `GITHUB_REF_SLUG_CS`
 
   </p>
 </details>
 
+Additional enhanced environment variables can be compute to help you around GitHub environment variables.
+
 ## Use this action
 
 Add this in your workflow
@@ -54,13 +63,21 @@ Add this in your workflow
   uses: rlespinasse/github-slug-action@v3.x
 ```
 
-Check for more [examples][3] (OS usage, URL use, ...)
+Check for more [examples][examples] (OS usage, URL use, ...)
 
-**Tip:** Use [Dependabot][14] to maintain your `github-slug-action` version updated in your GitHub workflows.
+**Tip:** Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows.
 
 ## 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][5].
+**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
 
@@ -73,36 +90,36 @@ Check for more [examples][3] (OS usage, URL use, ...)
 
 **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][4] 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][4] 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][4]<ul><li>`create`</li><li>`delete`</li></ul>           |
+| 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][4] 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][4] 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][4]<ul><li>`create`</li><li>`delete`</li></ul>           |
+| 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][4]<ul><li>`pull_request`</li><li>`pull_request_review`</li><li>`pull_request_review_comment`</li><li>`pull_request_target`</li></ul> |
+| 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> |
 
 ## Contribute
 
@@ -110,36 +127,44 @@ Follow [Developers guide](DEVELOPERS.md)
 
 ## Troubleshooting
 
-### One of environement variable don't work as intended
+### One of the environment variables doesn't work as intended
 
-[**Note**][17]: 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.
+[**Note**][naming-conventions]: When you set a custom environment variable, you cannot use any of the default environment variable names. For a complete list of these, see [Default environment variables][default-environment-variables]. **If you attempt to override the value of one of these default environment variables, the assignment is ignored.**
 
-Currently, a GitHub workflow setting a `GITHUB_` variable don't ended up in error.
-And if a custom `GITHUB_` variable is in conflict with an official `GITHUB_` variable, the offical `GITHUB_` variable will override custom one.
+If a variable start to be used as default environment variable, the environment variable may have a different behavior than the expected one.
 
-<details>
-  <summary>Test workflow</summary>
-  <p>
+If this append, the `${{ env.GITHUB_AWESOME_VARIABLE }}` and `$GITHUB_AWESOME_VARIABLE` expression will not works in the same way.
+
+- `${{ env.GITHUB_AWESOME_VARIABLE }}` will serve the behavior of this action,
+- `$GITHUB_AWESOME_VARIABLE` will serve the behavior of GitHub Action.
+
+Otherwise the two expression will serve the behavior of this action.
+This will not occurs if you use the `prefix` input to avoid the issue.
+
+**NOTE:** If detected, the maintainers of this action will choose the best course of action depending of the impact.
+
+#### Known environment variable conflicts
+
+##### GITHUB_REF_NAME
+
+The behavior is the same as the GitHub one except on `pull_request*` workflows ([Ready the full story][issue-104]).
+
+- `${{ env.GITHUB_REF_NAME }}` will serve the behavior of this action,
+- `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
+
+On `pull_request*` workflows, the content will be `<PR-number>/merge` instead of the branch name.
+
+A possible workaround is to use `prefix` input available in `v4` version
 
 ```yaml
-name: Test
-on: push
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - run: echo ${GITHUB_REF}
-      # print "refs/heads/v3.x"
-      - run: echo "GITHUB_REF=one_value" >> "$GITHUB_ENV"
-      - run: echo ${GITHUB_REF}
-      # print "refs/heads/v3.x"
-      - run: echo "GITHUB_REF_SLUG=another_value" >> "$GITHUB_ENV"
-      - run: echo ${GITHUB_REF_SLUG}
-      # print "another_value"
+- name: Inject slug/short variables
+  uses: rlespinasse/github-slug-action@v4
+  with:
+    prefix: CI_
 ```
 
-  </p>
-</details>
+Then `${{ env.CI_GITHUB_REF_NAME }}`, and `$CI_GITHUB_REF_NAME` will serve the behavior of this action.
+And `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
 
 ### An action could not be found at the URI
 
@@ -150,33 +175,36 @@ Download action repository 'rlespinasse/github-slug-action@master'
 ##[error]An action could not be found at the URI 'https://api.github.com/repos/rlespinasse/github-slug-action/tarball/master'
 ```
 
-> The master branch don't exists anymore.
+> The master branch doesn'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])
+> The master branch EOL has been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][issue-15])
 
-Please, use the current branch `v3.x` or a version tag (see [releases pages][6]) in order to fix your workflow.
+Please, use the current branch `v3.x` 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][15] (in french :fr:)
-- [Github Actions : enfin des pipelines accessibles aux développeurs][16] (in french :fr:)
-- The next one is you. _Don't hesitate to add you to this list._
+- [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._
 
-[1]: https://github.com/rlespinasse/github-slug-action/workflows/Build/badge.svg
-[2]: https://github.com/rlespinasse/github-slug-action/actions
-[3]: https://github.com/rlespinasse/github-slug-action/tree/v3.x/examples
-[4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
-[5]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
-[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/github-slug-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code
-[10]: https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables
-[11]: https://img.shields.io/github/license/rlespinasse/github-slug-action
-[12]: https://github.com/rlespinasse/github-slug-action/blob/v3.x/LICENSE
-[13]: https://github.com/rlespinasse/github-slug-action/workflows/Lint/badge.svg
-[14]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot
-[15]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8
-[16]: https://www.youtube.com/watch?v=RHnTJBwcE98
-[17]:
-https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables
+[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/v3.x/LICENSE
+[examples]: https://github.com/rlespinasse/github-slug-action/tree/v3.x/examples
+[custom-variable]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+[releases]: https://github.com/rlespinasse/github-slug-action/releases
+[issue-15]: https://github.com/rlespinasse/github-slug-action/issues/15
+[issue-104]: https://github.com/rlespinasse/github-slug-action/issues/104
+
+[default-environment-variables]: https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
+[dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+[webhooks-and-events]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
+[naming-conventions]: https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables
+
+[article-1]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8
+[article-2]: https://michaelheap.com/github-slug-action/
+[talk-1]: https://www.youtube.com/watch?v=RHnTJBwcE98

__tests__/slug.test.ts

@@ -35,6 +35,11 @@ test('slug: a number', () => {
   test_slug_cs('4.2', '4.2')
 })
 
+test('slug: an underscore', () => {
+  test_slug('An_Underscore', 'an_underscore')
+  test_slug_cs('An_Underscore', 'An_Underscore')
+})
+
 test('slug: special character', () => {
   test_slug('feat-(!è§-character', 'feat------character')
   test_slug_cs('feat-(!è§-character', 'feat------character')
@@ -47,22 +52,22 @@ test('slug: 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'
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
   )
   test_slug_cs(
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
   )
 })
 
 test('slug: short string after trailing', () => {
   test_slug(
-    '-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters-',
-    'an-awesome-feature-very-very-very-very-very-very-very-long-more'
+    '-has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters-',
+    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
   )
   test_slug_cs(
-    '-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters-',
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+    '-has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters-',
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
   )
 })

__tests__/slugref.test.ts

@@ -25,6 +25,11 @@ test('slug_ref: a fix branch', () => {
   test_slugref_cs('refs/heads/fix/issue_number', 'fix-issue_number')
 })
 
+test('slug_ref: an underscore', () => {
+  test_slugref('refs/heads/An_Underscore', 'an_underscore')
+  test_slugref_cs('refs/heads/An_Underscore', 'An_Underscore')
+})
+
 test('slug_ref: a simple tag', () => {
   test_slugref('refs/tags/v1.0.0', 'v1.0.0')
   test_slugref_cs('refs/tags/v1.0.0', 'v1.0.0')
@@ -52,12 +57,12 @@ test('slug_ref: test refs inside string', () => {
 
 test('slug_ref: a very long name', () => {
   test_slugref(
-    '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'
+    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
   )
   test_slugref_cs(
-    'refs/heads/an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
   )
 })
 

__tests__/slugurl.test.ts

@@ -35,6 +35,11 @@ test('slug_url: a number', () => {
   test_slugurl_cs('4.2', '4-2')
 })
 
+test('slug_url: an underscore', () => {
+  test_slugurl('An_Underscore', 'an-underscore')
+  test_slugurl_cs('An_Underscore', 'An-Underscore')
+})
+
 test('slug_url: trailing', () => {
   test_slugurl('.path.to.', 'path-to')
   test_slugurl_cs('.path.to.', 'path-to')
@@ -42,11 +47,11 @@ test('slug_url: trailing', () => {
 
 test('slug_url: a very long string', () => {
   test_slugurl(
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-feature-very-very-very-very-very-very-very-long-more'
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
   )
   test_slugurl_cs(
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
   )
 })

__tests__/slugurlref.test.ts

@@ -25,6 +25,11 @@ test('slug_url_ref: a fix branch', () => {
   test_slugurlref_cs('refs/heads/fix/issue_number', 'fix-issue-number')
 })
 
+test('slug_url_ref: an underscore', () => {
+  test_slugurlref('refs/heads/An_Underscore', 'an-underscore')
+  test_slugurlref_cs('refs/heads/An_Underscore', 'An-Underscore')
+})
+
 test('slug_url_ref: a simple tag', () => {
   test_slugurlref('refs/tags/v1.0.0', 'v1-0-0')
   test_slugurlref_cs('refs/tags/v1.0.0', 'v1-0-0')
@@ -42,12 +47,12 @@ test('slug_url_ref: a reference with upper case letters', () => {
 
 test('slug_url_ref: a very long name', () => {
   test_slugurlref(
-    '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'
+    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
   )
   test_slugurlref_cs(
-    'refs/heads/an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
-    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
   )
 })
 

examples/url-use.yml

@@ -9,7 +9,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: rlespinasse/github-slug-action@v3.x
       - run: |
-          ./deploy-application.sh --url "https://${{ env.GITHUB_REF_SLUG_URL }}.staging.app.mycompany.com"
+          ./deploy-application.sh --url "https://${{ env.GITHUB_REF_SLUG_URL }}.staging.app.example.com"
 
   as_resource_path:
     runs-on: ubuntu-latest
@@ -17,4 +17,4 @@ jobs:
       - uses: actions/checkout@v2
       - uses: rlespinasse/github-slug-action@v3.x
       - run: |
-          ./deploy-application.sh --url "https://staging.app.mycompany.com/${{ env.GITHUB_REF_SLUG_URL }}"
+          ./deploy-application.sh --url "https://staging.app.example.com/${{ env.GITHUB_REF_SLUG_URL }}"

package.json

@@ -17,7 +17,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "http://github.com/rlespinasse/github-slug-action.git"
+    "url": "https://github.com/rlespinasse/github-slug-action.git"
   },
   "keywords": [
     "actions",
@@ -26,37 +26,46 @@
   ],
   "author": "rlespinasse",
   "dependencies": {
-    "@actions/core": "^1.2.6"
+    "@actions/core": "^1.9.1"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^5.0.1",
-    "@semantic-release/git": "^9.0.0",
-    "@types/jest": "^26.0.20",
-    "@types/node": "^14.14.21",
-    "@typescript-eslint/parser": "^3.9.1",
+    "@semantic-release/exec": "^5.0.0",
+    "@semantic-release/git": "^9.0.1",
+    "@types/jest": "^26.0.24",
+    "@types/node": "^14.18.25",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@vercel/ncc": "^0.23.0",
-    "eslint": "^7.18.0",
-    "eslint-plugin-github": "^4.1.1",
+    "eslint": "^7.32.0",
+    "eslint-plugin-github": "^4.3.7",
     "eslint-plugin-jest": "^23.20.0",
     "jest": "^26.6.3",
     "jest-circus": "^26.6.3",
     "js-yaml": "^3.14.1",
-    "prettier": "^2.2.1",
-    "semantic-release": "^17.4.0",
-    "ts-jest": "^26.4.4",
-    "typescript": "^3.9.7"
+    "prettier": "^2.7.1",
+    "semantic-release": "^19.0.3",
+    "ts-jest": "^26.5.6",
+    "typescript": "^3.9.10"
   },
+  "files": [
+    "/dist"
+  ],
   "release": {
     "tagFormat": "${version}",
     "plugins": [
       "@semantic-release/commit-analyzer",
       "@semantic-release/release-notes-generator",
       "@semantic-release/changelog",
+      [
+        "@semantic-release/exec",
+        {
+          "prepareCmd": "git add dist"
+        }
+      ],
       "@semantic-release/git",
       "@semantic-release/github"
     ],
     "branches": [
-      "v2.x",
       "v3.x"
     ]
   }

src/main.ts

@@ -1,5 +1,6 @@
 import * as core from '@actions/core'
 import {
+  removeRef,
   slug,
   slug_cs,
   slugref,
@@ -31,6 +32,11 @@ const GITHUB_EVENT_PATH = 'GITHUB_EVENT_PATH'
 const GITHUB_REPOSITORY_OWNER_PART = 'GITHUB_REPOSITORY_OWNER_PART'
 const GITHUB_REPOSITORY_NAME_PART = 'GITHUB_REPOSITORY_NAME_PART'
 
+/**
+ * New environments variables keys
+ */
+const GITHUB_REF_NAME = 'GITHUB_REF_NAME'
+
 /**
  * Slugged outputs environments variables keys
  */
@@ -50,6 +56,8 @@ const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG'
 const GITHUB_BASE_REF_SLUG_CS = 'GITHUB_BASE_REF_SLUG_CS'
 const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG'
 const GITHUB_EVENT_REF_SLUG_CS = 'GITHUB_EVENT_REF_SLUG_CS'
+const GITHUB_REF_NAME_SLUG = 'GITHUB_REF_NAME_SLUG'
+const GITHUB_REF_NAME_SLUG_CS = 'GITHUB_REF_NAME_SLUG_CS'
 
 /**
  * URL-Slugged outputs environments variables keys
@@ -72,6 +80,8 @@ const GITHUB_BASE_REF_SLUG_URL = 'GITHUB_BASE_REF_SLUG_URL'
 const GITHUB_BASE_REF_SLUG_URL_CS = 'GITHUB_BASE_REF_SLUG_URL_CS'
 const GITHUB_EVENT_REF_SLUG_URL = 'GITHUB_EVENT_REF_SLUG_URL'
 const GITHUB_EVENT_REF_SLUG_URL_CS = 'GITHUB_EVENT_REF_SLUG_URL_CS'
+const GITHUB_REF_NAME_SLUG_URL = 'GITHUB_REF_NAME_SLUG_URL'
+const GITHUB_REF_NAME_SLUG_URL_CS = 'GITHUB_REF_NAME_SLUG_URL_CS'
 
 /**
  * Shorted outputs environments variables keys
@@ -168,6 +178,8 @@ async function run(): Promise<void> {
     exportSlugUrlRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL_CS)
 
     exportShortSha(GITHUB_SHA, GITHUB_SHA_SHORT)
+
+    exportBranchName()
   } catch (error) {
     core.setFailed(error.message)
   }
@@ -259,17 +271,25 @@ function exportSecondPartSlug(
 function exportSlugRefCS(inputKey: string, outputKey: string): void {
   const envVar = process.env[inputKey]
   if (envVar) {
-    core.exportVariable(outputKey, slugref_cs(envVar))
+    exportSlugRefCSValue(envVar, outputKey)
   }
 }
 
+function exportSlugRefCSValue(envVar: string, outputKey: string): void {
+  core.exportVariable(outputKey, slugref_cs(envVar))
+}
+
 function exportSlugRef(inputKey: string, outputKey: string): void {
   const envVar = process.env[inputKey]
   if (envVar) {
-    core.exportVariable(outputKey, slugref(envVar))
+    exportSlugRefValue(envVar, outputKey)
   }
 }
 
+function exportSlugRefValue(envVar: string, outputKey: string): void {
+  core.exportVariable(outputKey, slugref(envVar))
+}
+
 function exportSlugUrlCS(inputKey: string, outputKey: string): void {
   const envVar = process.env[inputKey]
   if (envVar) {
@@ -334,17 +354,25 @@ function exportSecondPartSlugUrl(
 function exportSlugUrlRefCS(inputKey: string, outputKey: string): void {
   const envVar = process.env[inputKey]
   if (envVar) {
-    core.exportVariable(outputKey, slugurlref_cs(envVar))
+    exportSlugUrlRefCSValue(envVar, outputKey)
   }
 }
 
+function exportSlugUrlRefCSValue(envVar: string, outputKey: string): void {
+  core.exportVariable(outputKey, slugurlref_cs(envVar))
+}
+
 function exportSlugUrlRef(inputKey: string, outputKey: string): void {
   const envVar = process.env[inputKey]
   if (envVar) {
-    core.exportVariable(outputKey, slugurlref(envVar))
+    exportSlugUrlRefValue(envVar, outputKey)
   }
 }
 
+function exportSlugUrlRefValue(envVar: string, outputKey: string): void {
+  core.exportVariable(outputKey, slugurlref(envVar))
+}
+
 function exportShortSha(inputKey: string, outputKey: string): void {
   const envVar = process.env[inputKey]
   if (envVar) {
@@ -352,4 +380,22 @@ function exportShortSha(inputKey: string, outputKey: string): void {
   }
 }
 
+function exportBranchName(): void {
+  //GITHUB_HEAD_REF is only set for pull request events https://docs.github.com/en/actions/reference/environment-variables
+  const isPullRequest = !!process.env.GITHUB_HEAD_REF
+  let refName
+  if (isPullRequest) {
+    refName = process.env.GITHUB_HEAD_REF
+  } else {
+    refName = process.env.GITHUB_REF
+  }
+  if (refName) {
+    core.exportVariable(GITHUB_REF_NAME, removeRef(refName))
+    exportSlugRefValue(refName, GITHUB_REF_NAME_SLUG)
+    exportSlugRefCSValue(refName, GITHUB_REF_NAME_SLUG_CS)
+    exportSlugUrlRefValue(refName, GITHUB_REF_NAME_SLUG_URL)
+    exportSlugUrlRefCSValue(refName, GITHUB_REF_NAME_SLUG_URL_CS)
+  }
+}
+
 run()

src/slug.ts

@@ -3,14 +3,17 @@ const MAX_SLUG_STRING_SIZE = 63
 /**
  * slug_cs will take envVar and then :
  * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
- * - remove leading and trailing `-` character
+ * - remove leading `-` characters
  * - limit the string size to 63 characters
+ * - remove trailing `-` characters
  * @param envVar to be slugged
  */
 export function slug_cs(envVar: string): string {
-  return trailHyphen(replaceAnyNonAlphanumericCharacter(envVar)).substring(
-    0,
-    MAX_SLUG_STRING_SIZE
+  return removeTrailingHyphens(
+    removeLeadingHyphens(replaceAnyNonAlphanumericCharacter(envVar)).substring(
+      0,
+      MAX_SLUG_STRING_SIZE
+    )
   )
 }
 
@@ -18,8 +21,9 @@ export function slug_cs(envVar: string): string {
  * 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
+ * - remove leading `-` characters
  * - limit the string size to 63 characters
+ * - remove trailing `-` characters
  * @param envVar to be slugged
  */
 export function slug(envVar: string): string {
@@ -30,8 +34,9 @@ export function slug(envVar: string): string {
  * slugref_cs will take envVar and then :
  * - remove refs/(heads|tags|pull)/
  * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
- * - remove leading and trailing `-` character
+ * - remove leading `-` characters
  * - limit the string size to 63 characters
+ * - remove trailing `-` characters
  * @param envVar to be slugged
  */
 export function slugref_cs(envVar: string): string {
@@ -43,8 +48,9 @@ export function slugref_cs(envVar: string): string {
  * - remove refs/(heads|tags|pull)/
  * - put the variable content in lower case
  * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
- * - remove leading and trailing `-` character
+ * - remove leading `-` characters
  * - limit the string size to 63 characters
+ * - remove trailing `-` characters
  * @param envVar to be slugged
  */
 export function slugref(envVar: string): string {
@@ -54,8 +60,9 @@ export function slugref(envVar: string): string {
 /**
  * slugurl_cs will take envVar and then :
  * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading and trailing `-` character
+ * - remove leading `-` characters
  * - limit the string size to 63 characters
+ * - remove trailing `-` characters
  * @param envVar to be slugged
  */
 export function slugurl_cs(envVar: string): string {
@@ -66,24 +73,26 @@ export function slugurl_cs(envVar: string): string {
  * slugurl 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
+ * - remove leading `-` characters
  * - limit the string size to 63 characters
+ * - remove trailing `-` characters
  * @param envVar to be slugged
  */
 export function slugurl(envVar: string): string {
-  return slug(replaceAnyNonUrlCharactersWithHyphen(envVar))
+  return slugurl_cs(envVar.toLowerCase())
 }
 
 /**
  * slugurlref_cs will take envVar and then :
  * - remove refs/(heads|tags|pull)/
  * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading and trailing `-` character
+ * - remove leading `-` characters
  * - limit the string size to 63 characters
+ * - remove trailing `-` characters
  * @param envVar to be slugged
  */
 export function slugurlref_cs(envVar: string): string {
-  return slugurl_cs(slugref_cs(envVar))
+  return slugurl_cs(removeRef(envVar))
 }
 
 /**
@@ -91,16 +100,20 @@ export function slugurlref_cs(envVar: string): string {
  * - remove refs/(heads|tags|pull)/
  * - put the variable content in lower case
  * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading and trailing `-` character
+ * - remove leading `-` characters
  * - limit the string size to 63 characters
+ * - remove trailing `-` characters
  * @param envVar to be slugged
  */
 export function slugurlref(envVar: string): string {
-  return slugurl(slugref(envVar))
+  return slugurlref_cs(envVar.toLowerCase())
 }
 
-function trailHyphen(envVar: string): string {
-  return envVar.replace(RegExp('^-*', 'g'), '').replace(RegExp('-*$', 'g'), '')
+function removeLeadingHyphens(envVar: string): string {
+  return envVar.replace(RegExp('^-*', 'g'), '')
+}
+function removeTrailingHyphens(envVar: string): string {
+  return envVar.replace(RegExp('-*$', 'g'), '')
 }
 
 function replaceAnyNonAlphanumericCharacter(envVar: string): string {
@@ -111,6 +124,6 @@ function replaceAnyNonUrlCharactersWithHyphen(envVar: string): string {
   return envVar.replace(RegExp('[._]', 'g'), '-')
 }
 
-function removeRef(envVar: string): string {
+export function removeRef(envVar: string): string {
   return envVar.replace(RegExp('^refs/(heads|tags|pull)/'), '')
 }