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))
ci: use checkout v3
2026-05-18 02:45:04 +00:00 · 2022-08-22 21:11:18 +00:00 · 2022-08-22 23:07:07 +02:00 · 2022-08-22 23:02:40 +02:00 · 2022-08-22 22:58:21 +02:00 · 2022-06-16 22:26:11 +02:00
36 changed files with 22344 additions and 7161 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/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -1,9 +0,0 @@
-version: 2
-updates:
-  # Enable version updates for npm
-  - package-ecosystem: 'npm'
-    # Look for `package.json` and `lock` files in the `root` directory
-    directory: '/'
-    # Check the npm registry for updates every day (weekdays)
-    schedule:
-      interval: 'daily'
--- 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/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,28 @@
+name: '[v3] CodeQL'
+
+on:
+  push:
+    branches:
+      - v3.x
+  pull_request:
+    branches:
+      - v3.x
+  schedule:
+    - cron: '0 6 * * 1'
+
+jobs:
+  analyse:
+    name: analyze
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ['javascript']
+    steps:
+      - 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
--- a/.github/workflows/github-slug.yml
+++ b/.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
--- a/.github/workflows/release-dryrun.yml
+++ b/.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 }}
--- a/.github/workflows/release.yml
+++ b/.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 }}
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,64 @@
+## [3.6.1](https://github.com/rlespinasse/github-slug-action/compare/3.6.0...3.6.1) (2022-08-22)
+
+
+### Bug Fixes
+
+* remove trailing hyphens if any after cut ([19f9c84](https://github.com/rlespinasse/github-slug-action/commit/19f9c84ac61b17071a3cfc4ae984ac0e2ba1cdae))
+
+# [3.6.0](http://github.com/rlespinasse/github-slug-action/compare/3.5.1...3.6.0) (2021-09-15)
+
+
+### Features
+
+* add GITHUB_REF_NAME env var ([12a7510](http://github.com/rlespinasse/github-slug-action/commit/12a75106304d45442301df66d3ba38e1ac002649))
+
+## [3.5.1](http://github.com/rlespinasse/github-slug-action/compare/3.5.0...3.5.1) (2021-03-31)
+
+
+### Bug Fixes
+
+* update dist files ([e6c550f](http://github.com/rlespinasse/github-slug-action/commit/e6c550f88ccca52a82675b89186b6b72864f087c))
+
+# [3.5.0](http://github.com/rlespinasse/github-slug-action/compare/3.4.0...3.5.0) (2021-03-30)
+
+
+### Features
+
+* allow underscore in slug values ([475d293](http://github.com/rlespinasse/github-slug-action/commit/475d293680b998a3315846828329f05bfff4ac9c))
+
+# [3.4.0](http://github.com/rlespinasse/github-slug-action/compare/3.3.0...3.4.0) (2021-03-02)
+
+
+### Features
+
+* add _CS suffix to keep value case-sensitive ([6c93fcb](http://github.com/rlespinasse/github-slug-action/commit/6c93fcbf53da9c6415bd7f5e37579b488f34339e))
+
+# [3.3.0](http://github.com/rlespinasse/github-slug-action/compare/3.2.0...3.3.0) (2021-01-25)
+
+
+### Bug Fixes
+
+* support pull-request for slug and slug url ([78985f8](http://github.com/rlespinasse/github-slug-action/commit/78985f84eca97ef1c5262e85e8a73a277494c4ed))
+
+
+### Features
+
+* support partial GITHUB_REPOSITORY ([75ce03b](http://github.com/rlespinasse/github-slug-action/commit/75ce03b6a055a3be9d936a3a99c51038bd72298c))
+
+# [3.2.0](http://github.com/rlespinasse/github-slug-action/compare/3.1.0...3.2.0) (2021-01-12)
+
+
+### Features
+
+* expose GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT ([5b9fe60](http://github.com/rlespinasse/github-slug-action/commit/5b9fe6015d2facc71c81d53bf3b08f04e0f3f743))
+
+# [3.1.0](http://github.com/rlespinasse/github-slug-action/compare/3.0.0...3.1.0) (2020-11-01)
+
+
+### Features
+
+* **action:** improve marketplace information ([3cddc4f](http://github.com/rlespinasse/github-slug-action/commit/3cddc4f12d7a6fdbb8b1221dc02a2c64670e54bf))
+
 # [3.0.0](http://github.com/rlespinasse/github-slug-action/compare/2.1.0...3.0.0) (2020-10-26)


--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# How to contribute to GitHub Slug Action
+
+## Did you find a bug
+
+* **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to refer to our [security policy][1].
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues][2].
+
+* If you're unable to find an open issue addressing the problem, [open a 'Bug' issue][4].
+Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+## Did you write a patch that fixes a bug
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution.
+Include the relevant issue number if applicable.
+
+## Do you intend to add a new feature or change an existing one
+
+* Suggest your change by [opening a 'Feature request' issue][5] and start writing code (following the [developers guide](DEVELOPERS.md))
+
+## Do you have questions about the source code
+
+* [open an issue][3] with your question.
+
+Thanks!
+
+[1]: https://github.com/rlespinasse/github-slug-action/security/policy
+[2]: https://github.com/rlespinasse/github-slug-action/issues
+[3]: https://github.com/rlespinasse/github-slug-action/issues/new
+[4]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=bug&template=bug_report.md&title=
+[5]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
--- a/DEVELOPERS.md
+++ b/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
+```
--- a/README.md
+++ b/README.md
@@ -1,118 +1,125 @@
 # 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][default-environment-variables] 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)
+  - [Contribute](#contribute)
+  - [Troubleshooting](#troubleshooting)
+    - [One of the environment variables doesn't work as intended](#one-of-the-environment-variables-doesnt-work-as-intended)
+      - [Known environment variable conflicts](#known-environment-variable-conflicts)
+        - [GITHUB_REF_NAME](#github_ref_name)
+    - [An action could not be found at the URI](#an-action-could-not-be-found-at-the-uri)
+  - [Thanks for talking about us](#thanks-for-talking-about-us)
+
+## Overview
+
+`SLUG` on a variable will

 - put the variable content in lower case
- replace any character by `-` except `0-9`, `a-z`, and `.`
- remove leading and trailing `-` character
+- replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
+- remove leading `-` characters
 - limit the string size to 63 characters
+- remove trailing `-` 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@v2.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@v3.x
 ```

-Read [default environment variables][3] page for more information.
+Check for more [examples][examples] (OS usage, URL use, ...)

-### GITHUB_REF_SLUG / GITHUB_REF_SLUG_URL
+**Tip:** Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows.

-Slug the environment variable **GITHUB_REF**
+## Available Environment variables

-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._
+**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].

-| 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 |
+### Enhanced variables

-> **NOTE :**
-> GITHUB_REF_SLUG_URL is design to be used as subdomain in an URL.
+- `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.

-_Additional variables (only set for forked repositories) :_
+**NOTE:** All enhanced variables are available in all **slug** formats.

- `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**
+### Partial variables

-_Additional variables (only set for [create][4], and [delete][5] webhook events with `ref` data) :_
+| 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 |

- `GITHUB_EVENT_REF_SLUG`/`GITHUB_EVENT_REF_SLUG_URL`, The git reference resource associated to the webhook.
+### Slug variables

-### GITHUB_REPOSITORY_SLUG / GITHUB_REPOSITORY_SLUG_URL
+**NOTE:** `_CS` suffix available

-Slug the environment variable **GITHUB_REPOSITORY**
+| 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>          |

-The owner and repository name.
+### Slug URL variables

-| 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:** `_CS` suffix available

-> **NOTE :**
-> GITHUB_REPOSITORY_SLUG_URL is design to be used as subdomain in an URL.
+| 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>           |

-### GITHUB_SHA_SHORT
+### Short variables

-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*.
-
-```yaml
- name: Inject slug/short variables
-  uses: rlespinasse/github-slug-action@v2.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 }}"
-```
+| 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

@@ -120,7 +127,46 @@ Follow [Developers guide](DEVELOPERS.md)

 ## Troubleshooting

-### Missing master branch
+### One of the environment variables doesn't work as intended
+
+[**Note**][naming-conventions]: When you set a custom environment variable, you cannot use any of the default environment variable names. For a complete list of these, see [Default environment variables][default-environment-variables]. **If you attempt to override the value of one of these default environment variables, the assignment is ignored.**
+
+If a variable start to be used as default environment variable, the environment variable may have a different behavior than the expected one.
+
+If this append, the `${{ env.GITHUB_AWESOME_VARIABLE }}` and `$GITHUB_AWESOME_VARIABLE` expression will not works in the same way.
+
+- `${{ env.GITHUB_AWESOME_VARIABLE }}` will serve the behavior of this action,
+- `$GITHUB_AWESOME_VARIABLE` will serve the behavior of GitHub Action.
+
+Otherwise the two expression will serve the behavior of this action.
+This will not occurs if you use the `prefix` input to avoid the issue.
+
+**NOTE:** If detected, the maintainers of this action will choose the best course of action depending of the impact.
+
+#### Known environment variable conflicts
+
+##### GITHUB_REF_NAME
+
+The behavior is the same as the GitHub one except on `pull_request*` workflows ([Ready the full story][issue-104]).
+
+- `${{ env.GITHUB_REF_NAME }}` will serve the behavior of this action,
+- `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
+
+On `pull_request*` workflows, the content will be `<PR-number>/merge` instead of the branch name.
+
+A possible workaround is to use `prefix` input available in `v4` version
+
+```yaml
+- name: Inject slug/short variables
+  uses: rlespinasse/github-slug-action@v4
+  with:
+    prefix: CI_
+```
+
+Then `${{ env.CI_GITHUB_REF_NAME }}`, and `$CI_GITHUB_REF_NAME` will serve the behavior of this action.
+And `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
+
+### An action could not be found at the URI

 If your workflow fail on the `Set up job` task with this kind of log :

@@ -129,16 +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'
 ```

-Use the current branch `v2.x` or a version tag (see [releases pages][6]).
+> The master branch doesn't exists anymore.
+>
+> The master branch EOL has been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][issue-15])

-The master branch EOL is set on **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][7])
+Please, use the current branch `v3.x` or a version tag (see [releases pages][releases]) in order to fix your workflow.

-[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
+## 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/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
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -6,8 +6,8 @@
 |---------|--------|--------------------|
 | 3.x     | v3.x   | :white_check_mark: |
 | 2.x     | v2.x   | :white_check_mark: |
-| 1.1.x   | v1.1.x | :white_check_mark: |
-| < 1.0.x | master | :x:                |
+| 1.1.x   | v1.1.x | :x:                |
+| < 1.x   |        | :x:                |

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

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

 function test_short_sha(input: string, expected: string) {
  let actual = shortsha(input)
--- a/tests/slug.test.ts
+++ b/tests/slug.test.ts
@@ -1,48 +1,73 @@
-import {slug} from '../src/slug'
+import {slug, slug_cs} from '../src/slug'

 function test_slug(input: string, expected: string) {
  let actual = slug(input)
  expect(actual).toEqual(expected)
 }

+function test_slug_cs(input: string, expected: string) {
+  let actual = slug_cs(input)
+  expect(actual).toEqual(expected)
+}
+
 test('slug: a word', () => {
  test_slug('word', 'word')
+  test_slug_cs('word', 'word')
 })

 test('slug: a string', () => {
  test_slug('basic-string', 'basic-string')
+  test_slug_cs('basic-string', 'basic-string')
 })

 test('slug: a string in camel case', () => {
  test_slug('camelCase', 'camelcase')
+  test_slug_cs('camelCase', 'camelCase')
 })

 test('slug: a path', () => {
  test_slug('path/to/something', 'path-to-something')
+  test_slug_cs('path/to/something', 'path-to-something')
 })

 test('slug: a number', () => {
  test_slug('4.2', '4.2')
+  test_slug_cs('4.2', '4.2')
 })

-test('slug: special caracter', () => {
-  test_slug('feat-(!è§-caracter', 'feat------caracter')
+test('slug: an underscore', () => {
+  test_slug('An_Underscore', 'an_underscore')
+  test_slug_cs('An_Underscore', 'An_Underscore')
+})
+
+test('slug: special character', () => {
+  test_slug('feat-(!è§-character', 'feat------character')
+  test_slug_cs('feat-(!è§-character', 'feat------character')
 })

 test('slug: trailing', () => {
  test_slug('-feat-trailing-', 'feat-trailing')
+  test_slug_cs('-feat-trailing-', 'feat-trailing')
 })

 test('slug: a very long string', () => {
  test_slug(
-    '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(
+    '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(
+    '-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'
  )
 })
--- a/tests/slugref.test.ts
+++ b/tests/slugref.test.ts
@@ -1,45 +1,72 @@
-import {slugref} from '../src/slug'
+import {slugref, slugref_cs} from '../src/slug'

-function test_slug_ref(input: string, expected: string) {
+function test_slugref(input: string, expected: string) {
  let actual = slugref(input)
  expect(actual).toEqual(expected)
 }

+function test_slugref_cs(input: string, expected: string) {
+  let actual = slugref_cs(input)
+  expect(actual).toEqual(expected)
+}
+
 test('slug_ref:: master branch', () => {
-  test_slug_ref('refs/heads/master', 'master')
+  test_slugref('refs/heads/master', 'master')
+  test_slugref_cs('refs/heads/master', 'master')
 })

 test('slug_ref: a feature branch', () => {
-  test_slug_ref('refs/heads/feat/new_feature', 'feat-new-feature')
+  test_slugref('refs/heads/feat/new_feature', 'feat-new_feature')
+  test_slugref_cs('refs/heads/feat/new_feature', 'feat-new_feature')
 })

 test('slug_ref: a fix branch', () => {
-  test_slug_ref('refs/heads/fix/issue_number', 'fix-issue-number')
+  test_slugref('refs/heads/fix/issue_number', 'fix-issue_number')
+  test_slugref_cs('refs/heads/fix/issue_number', 'fix-issue_number')
+})
+
+test('slug_ref: an underscore', () => {
+  test_slugref('refs/heads/An_Underscore', 'an_underscore')
+  test_slugref_cs('refs/heads/An_Underscore', 'An_Underscore')
 })

 test('slug_ref: a simple tag', () => {
-  test_slug_ref('refs/tags/v1.0.0', 'v1.0.0')
+  test_slugref('refs/tags/v1.0.0', 'v1.0.0')
+  test_slugref_cs('refs/tags/v1.0.0', 'v1.0.0')
 })

 test('slug_ref: a complex tag', () => {
-  test_slug_ref('refs/tags/product@1.0.0-rc.2', 'product-1.0.0-rc.2')
+  test_slugref('refs/tags/product@1.0.0-rc.2', 'product-1.0.0-rc.2')
+  test_slugref_cs('refs/tags/product@1.0.0-rc.2', 'product-1.0.0-rc.2')
 })

 test('slug_ref: a reference with upper case letters', () => {
-  test_slug_ref('refs/heads/New_Awesome_Product', 'new-awesome-product')
+  test_slugref('refs/heads/New_Awesome_Product', 'new_awesome_product')
+  test_slugref_cs('refs/heads/New_Awesome_Product', 'New_Awesome_Product')
 })

 test('slug_ref: test trailing', () => {
-  test_slug_ref('refs/heads/-trailing-feat-', 'trailing-feat')
+  test_slugref('refs/heads/-trailing-feat-', 'trailing-feat')
+  test_slugref_cs('refs/heads/-trailing-feat-', 'trailing-feat')
 })

 test('slug_ref: test refs inside string', () => {
-  test_slug_ref('refs/heads/-refs/tags/feature/-', 'refs-tags-feature')
+  test_slugref('refs/heads/-refs/tags/feature/-', 'refs-tags-feature')
+  test_slugref_cs('refs/heads/-refs/tags/feature/-', 'refs-tags-feature')
 })

 test('slug_ref: a very long name', () => {
-  test_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'
+  test_slugref(
+    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
+  )
+  test_slugref_cs(
+    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
  )
 })
+
+test('slug_ref: on pull-request ref', () => {
+  test_slugref('refs/pull/branch', 'branch')
+  test_slugref_cs('refs/pull/branch', 'branch')
+})
--- a/tests/slugurl.test.ts
+++ b/tests/slugurl.test.ts
@@ -1,37 +1,57 @@
-import {slugurl} from '../src/slug'
+import {slugurl, slugurl_cs} from '../src/slug'

-function test_slug_url(input: string, expected: string) {
+function test_slugurl(input: string, expected: string) {
  let actual = slugurl(input)
  expect(actual).toEqual(expected)
 }

+function test_slugurl_cs(input: string, expected: string) {
+  let actual = slugurl_cs(input)
+  expect(actual).toEqual(expected)
+}
+
 test('slug_url: a word', () => {
-  test_slug_url('word', 'word')
+  test_slugurl('word', 'word')
+  test_slugurl_cs('word', 'word')
 })

 test('slug_url: a string', () => {
-  test_slug_url('basic-string', 'basic-string')
+  test_slugurl('basic-string', 'basic-string')
+  test_slugurl_cs('basic-string', 'basic-string')
 })

 test('slug_url: a string in camel case', () => {
-  test_slug_url('camelCase', 'camelcase')
+  test_slugurl('camelCase', 'camelcase')
+  test_slugurl_cs('camelCase', 'camelCase')
 })

 test('slug_url: a path', () => {
-  test_slug_url('path/to/something', 'path-to-something')
+  test_slugurl('path/to/something', 'path-to-something')
+  test_slugurl_cs('path/to/something', 'path-to-something')
 })

 test('slug_url: a number', () => {
-  test_slug_url('4.2', '4-2')
+  test_slugurl('4.2', '4-2')
+  test_slugurl_cs('4.2', '4-2')
+})
+
+test('slug_url: an underscore', () => {
+  test_slugurl('An_Underscore', 'an-underscore')
+  test_slugurl_cs('An_Underscore', 'An-Underscore')
 })

 test('slug_url: trailing', () => {
-  test_slug_url('.path.to.', 'path-to')
+  test_slugurl('.path.to.', 'path-to')
+  test_slugurl_cs('.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'
+  test_slugurl(
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
+  )
+  test_slugurl_cs(
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
  )
 })
--- a/tests/slugurlref.test.ts
+++ b/tests/slugurlref.test.ts
@@ -1,45 +1,72 @@
-import {slugurlref} from '../src/slug'
+import {slugurlref, slugurlref_cs} from '../src/slug'

-function test_slug_url_ref(input: string, expected: string) {
+function test_slugurlref(input: string, expected: string) {
  let actual = slugurlref(input)
  expect(actual).toEqual(expected)
 }

+function test_slugurlref_cs(input: string, expected: string) {
+  let actual = slugurlref_cs(input)
+  expect(actual).toEqual(expected)
+}
+
 test('slug_url_ref: master branch', () => {
-  test_slug_url_ref('refs/heads/master', 'master')
+  test_slugurlref('refs/heads/master', 'master')
+  test_slugurlref_cs('refs/heads/master', 'master')
 })

 test('slug_url_ref: a feature branch', () => {
-  test_slug_url_ref('refs/heads/feat/new_feature', 'feat-new-feature')
+  test_slugurlref('refs/heads/feat/new_feature', 'feat-new-feature')
+  test_slugurlref_cs('refs/heads/feat/new_feature', 'feat-new-feature')
 })

 test('slug_url_ref: a fix branch', () => {
-  test_slug_url_ref('refs/heads/fix/issue_number', 'fix-issue-number')
+  test_slugurlref('refs/heads/fix/issue_number', 'fix-issue-number')
+  test_slugurlref_cs('refs/heads/fix/issue_number', 'fix-issue-number')
+})
+
+test('slug_url_ref: an underscore', () => {
+  test_slugurlref('refs/heads/An_Underscore', 'an-underscore')
+  test_slugurlref_cs('refs/heads/An_Underscore', 'An-Underscore')
 })

 test('slug_url_ref: a simple tag', () => {
-  test_slug_url_ref('refs/tags/v1.0.0', 'v1-0-0')
+  test_slugurlref('refs/tags/v1.0.0', 'v1-0-0')
+  test_slugurlref_cs('refs/tags/v1.0.0', 'v1-0-0')
 })

 test('slug_url_ref: a complex tag', () => {
-  test_slug_url_ref('refs/tags/product@1.0.0-rc.2', 'product-1-0-0-rc-2')
+  test_slugurlref('refs/tags/product@1.0.0-rc.2', 'product-1-0-0-rc-2')
+  test_slugurlref_cs('refs/tags/product@1.0.0-rc.2', 'product-1-0-0-rc-2')
 })

 test('slug_url_ref: a reference with upper case letters', () => {
-  test_slug_url_ref('refs/heads/New_Awesome_Product', 'new-awesome-product')
+  test_slugurlref('refs/heads/New_Awesome_Product', 'new-awesome-product')
+  test_slugurlref_cs('refs/heads/New_Awesome_Product', 'New-Awesome-Product')
 })

 test('slug_url_ref: a very long name', () => {
-  test_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_slugurlref(
+    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-feature-very-very-very-very-very-very-very-long'
+  )
+  test_slugurlref_cs(
+    'refs/heads/has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'has-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long'
  )
 })

 test('slug_url_ref: test trailing', () => {
-  test_slug_url_ref('refs/heads/-an-awesome-Feature-', 'an-awesome-feature')
+  test_slugurlref('refs/heads/-an-awesome-Feature-', 'an-awesome-feature')
+  test_slugurlref_cs('refs/heads/-an-awesome-Feature-', 'an-awesome-Feature')
 })

 test('slug_url_ref: test trailing with dot', () => {
-  test_slug_url_ref('refs/heads/.an-awesome-Feature.', 'an-awesome-feature')
+  test_slugurlref('refs/heads/.an-awesome-Feature.', 'an-awesome-feature')
+  test_slugurlref_cs('refs/heads/.an-awesome-Feature.', 'an-awesome-Feature')
+})
+
+test('slug_url_ref: on pull-request ref', () => {
+  test_slugurlref('refs/pull/branch', 'branch')
+  test_slugurlref_cs('refs/pull/branch', 'branch')
 })
--- a/action.yml
+++ b/action.yml
@@ -1,9 +1,9 @@
-name: "GitHub Slug"
-description: "Action to slug and expose some github variables"
+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'
 branding:
-  icon: "crop"
-  color: "orange"
+  icon: "minimize"
+  color: "blue"
--- a/dist/index.js
+++ b/dist/index.js
--- a/dist/index.js.map
+++ b/dist/index.js.map
--- 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@v3.x
+      - 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@v3.x
+      - 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@v3.x
+      - run: |
+          ./deploy-application.sh --url "https://${{ env.GITHUB_REF_SLUG_URL }}.staging.app.example.com"
+
+  as_resource_path:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: rlespinasse/github-slug-action@v3.x
+      - 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@v3.x
+      - 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/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/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,38 +26,47 @@
  ],
  "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.10",
-    "@types/node": "^14.6.0",
-    "@typescript-eslint/parser": "^3.9.1",
+    "@semantic-release/changelog": "^5.0.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.5.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.4.2",
-    "jest-circus": "^26.4.1",
-    "js-yaml": "^3.14.0",
-    "prettier": "2.0.5",
-    "semantic-release": "17.0.7",
-    "ts-jest": "^26.3.0",
-    "typescript": "^3.9.7"
+    "jest": "^26.6.3",
+    "jest-circus": "^26.6.3",
+    "js-yaml": "^3.14.1",
+    "prettier": "^2.7.1",
+    "semantic-release": "^19.0.3",
+    "ts-jest": "^26.5.6",
+    "typescript": "^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": [
-      "v1.1.x",
-      "v2.x"
+      "v3.x"
    ]
  }
 }
--- a/src/main.ts
+++ b/src/main.ts
@@ -1,5 +1,19 @@
 import * as core from '@actions/core'
-import {slugref, slug, slugurl, slugurlref, shortsha} from './slug'
+import {
+  removeRef,
+  slug,
+  slug_cs,
+  slugref,
+  slugref_cs,
+  slugurl,
+  slugurl_cs,
+  slugurlref,
+  slugurlref_cs
+} from './slug'
+import {shortsha} from './short'
+import {get_first_part, get_second_part} from './partial'
+
+const SEPARATOR = '/'

 /**
 * Inputs environments variables keys from Github actions job
@@ -12,20 +26,69 @@ const GITHUB_BASE_REF = 'GITHUB_BASE_REF'
 const GITHUB_SHA = 'GITHUB_SHA'
 const GITHUB_EVENT_PATH = 'GITHUB_EVENT_PATH'

+/**
+ * Partial outputs environments variables keys
+ */
+const GITHUB_REPOSITORY_OWNER_PART = 'GITHUB_REPOSITORY_OWNER_PART'
+const GITHUB_REPOSITORY_NAME_PART = 'GITHUB_REPOSITORY_NAME_PART'
+
+/**
+ * New environments variables keys
+ */
+const GITHUB_REF_NAME = 'GITHUB_REF_NAME'
+
 /**
 * Slugged outputs environments variables keys
 */
 const GITHUB_REPOSITORY_SLUG = 'GITHUB_REPOSITORY_SLUG'
-const GITHUB_REPOSITORY_SLUG_URL = 'GITHUB_REPOSITORY_SLUG_URL'
+const GITHUB_REPOSITORY_SLUG_CS = 'GITHUB_REPOSITORY_SLUG_CS'
+const GITHUB_REPOSITORY_OWNER_PART_SLUG = 'GITHUB_REPOSITORY_OWNER_PART_SLUG'
+const GITHUB_REPOSITORY_OWNER_PART_SLUG_CS =
+  'GITHUB_REPOSITORY_OWNER_PART_SLUG_CS'
+const GITHUB_REPOSITORY_NAME_PART_SLUG = 'GITHUB_REPOSITORY_NAME_PART_SLUG'
+const GITHUB_REPOSITORY_NAME_PART_SLUG_CS =
+  'GITHUB_REPOSITORY_NAME_PART_SLUG_CS'
 const GITHUB_REF_SLUG = 'GITHUB_REF_SLUG'
+const GITHUB_REF_SLUG_CS = 'GITHUB_REF_SLUG_CS'
 const GITHUB_HEAD_REF_SLUG = 'GITHUB_HEAD_REF_SLUG'
+const GITHUB_HEAD_REF_SLUG_CS = 'GITHUB_HEAD_REF_SLUG_CS'
 const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG'
-const GITHUB_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_BASE_REF_SLUG_CS = 'GITHUB_BASE_REF_SLUG_CS'
 const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG'
+const GITHUB_EVENT_REF_SLUG_CS = 'GITHUB_EVENT_REF_SLUG_CS'
+const GITHUB_REF_NAME_SLUG = 'GITHUB_REF_NAME_SLUG'
+const GITHUB_REF_NAME_SLUG_CS = 'GITHUB_REF_NAME_SLUG_CS'
+
+/**
+ * URL-Slugged outputs environments variables keys
+ */
+const GITHUB_REPOSITORY_SLUG_URL = 'GITHUB_REPOSITORY_SLUG_URL'
+const GITHUB_REPOSITORY_SLUG_URL_CS = 'GITHUB_REPOSITORY_SLUG_URL_CS'
+const GITHUB_REPOSITORY_OWNER_PART_SLUG_URL =
+  'GITHUB_REPOSITORY_OWNER_PART_SLUG_URL'
+const GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS =
+  'GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS'
+const GITHUB_REPOSITORY_NAME_PART_SLUG_URL =
+  'GITHUB_REPOSITORY_NAME_PART_SLUG_URL'
+const GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS =
+  'GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS'
+const GITHUB_REF_SLUG_URL = 'GITHUB_REF_SLUG_URL'
+const GITHUB_REF_SLUG_URL_CS = 'GITHUB_REF_SLUG_URL_CS'
+const GITHUB_HEAD_REF_SLUG_URL = 'GITHUB_HEAD_REF_SLUG_URL'
+const GITHUB_HEAD_REF_SLUG_URL_CS = 'GITHUB_HEAD_REF_SLUG_URL_CS'
+const GITHUB_BASE_REF_SLUG_URL = 'GITHUB_BASE_REF_SLUG_URL'
+const GITHUB_BASE_REF_SLUG_URL_CS = 'GITHUB_BASE_REF_SLUG_URL_CS'
 const GITHUB_EVENT_REF_SLUG_URL = 'GITHUB_EVENT_REF_SLUG_URL'
+const GITHUB_EVENT_REF_SLUG_URL_CS = 'GITHUB_EVENT_REF_SLUG_URL_CS'
+const GITHUB_REF_NAME_SLUG_URL = 'GITHUB_REF_NAME_SLUG_URL'
+const GITHUB_REF_NAME_SLUG_URL_CS = 'GITHUB_REF_NAME_SLUG_URL_CS'
+
+/**
+ * Shorted outputs environments variables keys
+ */
+const GITHUB_SHA_SHORT = 'GITHUB_SHA_SHORT'
+const GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT =
+  'GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT'

 async function run(): Promise<void> {
  try {
@@ -34,31 +97,122 @@ async function run(): Promise<void> {
      const eventData = await import(eventPath)
      if (eventData.hasOwnProperty('ref')) {
        core.exportVariable(GITHUB_EVENT_REF_SLUG, slugref(eventData.ref))
+        core.exportVariable(GITHUB_EVENT_REF_SLUG_CS, slugref_cs(eventData.ref))
        core.exportVariable(
          GITHUB_EVENT_REF_SLUG_URL,
          slugurlref(eventData.ref)
        )
+        core.exportVariable(
+          GITHUB_EVENT_REF_SLUG_URL_CS,
+          slugurlref_cs(eventData.ref)
+        )
+      } else if (eventData.hasOwnProperty('pull_request')) {
+        core.exportVariable(
+          GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT,
+          shortsha(eventData.pull_request.head.sha)
+        )
      }
    }

+    exportFirstPart(GITHUB_REPOSITORY, SEPARATOR, GITHUB_REPOSITORY_OWNER_PART)
+    exportSecondPart(GITHUB_REPOSITORY, SEPARATOR, GITHUB_REPOSITORY_NAME_PART)
+
    exportSlug(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG)
+    exportSlugCS(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_CS)
+    exportFirstPartSlug(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_OWNER_PART_SLUG
+    )
+    exportFirstPartSlugCS(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_OWNER_PART_SLUG_CS
+    )
+    exportSecondPartSlug(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_NAME_PART_SLUG
+    )
+    exportSecondPartSlugCS(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_NAME_PART_SLUG_CS
+    )

    exportSlugUrl(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_URL)
+    exportSlugUrlCS(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_URL_CS)
+    exportFirstPartSlugUrl(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_OWNER_PART_SLUG_URL
+    )
+    exportFirstPartSlugUrlCS(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS
+    )
+    exportSecondPartSlugUrl(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_NAME_PART_SLUG_URL
+    )
+    exportSecondPartSlugUrlCS(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS
+    )

    exportSlugRef(GITHUB_REF, GITHUB_REF_SLUG)
+    exportSlugRefCS(GITHUB_REF, GITHUB_REF_SLUG_CS)
    exportSlugRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG)
+    exportSlugRefCS(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_CS)
    exportSlugRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG)
+    exportSlugRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_CS)

    exportSlugUrlRef(GITHUB_REF, GITHUB_REF_SLUG_URL)
+    exportSlugUrlRefCS(GITHUB_REF, GITHUB_REF_SLUG_URL_CS)
    exportSlugUrlRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_URL)
+    exportSlugUrlRefCS(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_URL_CS)
    exportSlugUrlRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL)
+    exportSlugUrlRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL_CS)

    exportShortSha(GITHUB_SHA, GITHUB_SHA_SHORT)
+
+    exportBranchName()
  } catch (error) {
    core.setFailed(error.message)
  }
 }

+function exportFirstPart(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, get_first_part(envVar, separator))
+  }
+}
+
+function exportSecondPart(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, get_second_part(envVar, separator))
+  }
+}
+
+function exportSlugCS(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, slug_cs(envVar))
+  }
+}
 function exportSlug(inputKey: string, outputKey: string): void {
  const envVar = process.env[inputKey]
  if (envVar) {
@@ -66,13 +220,82 @@ function exportSlug(inputKey: string, outputKey: string): void {
  }
 }

-function exportSlugRef(inputKey: string, outputKey: string): void {
+function exportFirstPartSlugCS(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
  const envVar = process.env[inputKey]
  if (envVar) {
-    core.exportVariable(outputKey, slugref(envVar))
+    const value = get_first_part(envVar, separator)
+    core.exportVariable(outputKey, slug_cs(value))
  }
 }

+function exportFirstPartSlug(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_first_part(envVar, separator)
+    core.exportVariable(outputKey, slug(value))
+  }
+}
+
+function exportSecondPartSlugCS(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_second_part(envVar, separator)
+    core.exportVariable(outputKey, slug_cs(value))
+  }
+}
+
+function exportSecondPartSlug(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_second_part(envVar, separator)
+    core.exportVariable(outputKey, slug(value))
+  }
+}
+
+function exportSlugRefCS(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    exportSlugRefCSValue(envVar, outputKey)
+  }
+}
+
+function exportSlugRefCSValue(envVar: string, outputKey: string): void {
+  core.exportVariable(outputKey, slugref_cs(envVar))
+}
+
+function exportSlugRef(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    exportSlugRefValue(envVar, outputKey)
+  }
+}
+
+function exportSlugRefValue(envVar: string, outputKey: string): void {
+  core.exportVariable(outputKey, slugref(envVar))
+}
+
+function exportSlugUrlCS(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, slugurl_cs(envVar))
+  }
+}
 function exportSlugUrl(inputKey: string, outputKey: string): void {
  const envVar = process.env[inputKey]
  if (envVar) {
@@ -80,13 +303,76 @@ function exportSlugUrl(inputKey: string, outputKey: string): void {
  }
 }

+function exportFirstPartSlugUrlCS(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_first_part(envVar, separator)
+    core.exportVariable(outputKey, slugurl_cs(value))
+  }
+}
+
+function exportFirstPartSlugUrl(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_first_part(envVar, separator)
+    core.exportVariable(outputKey, slugurl(value))
+  }
+}
+
+function exportSecondPartSlugUrlCS(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_second_part(envVar, separator)
+    core.exportVariable(outputKey, slugurl_cs(value))
+  }
+}
+
+function exportSecondPartSlugUrl(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_second_part(envVar, separator)
+    core.exportVariable(outputKey, slugurl(value))
+  }
+}
+
+function exportSlugUrlRefCS(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    exportSlugUrlRefCSValue(envVar, outputKey)
+  }
+}
+
+function exportSlugUrlRefCSValue(envVar: string, outputKey: string): void {
+  core.exportVariable(outputKey, slugurlref_cs(envVar))
+}
+
 function exportSlugUrlRef(inputKey: string, outputKey: string): void {
  const envVar = process.env[inputKey]
  if (envVar) {
-    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) {
@@ -94,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()
--- a/src/partial.ts
+++ b/src/partial.ts
@@ -0,0 +1,17 @@
+/**
+ * Get the first part of envVar
+ * @param envVar to be split
+ * @param separator of the split
+ */
+export function get_first_part(envVar: string, separator: string): string {
+  return envVar.replace(RegExp(`${separator}.*$`), '')
+}
+
+/**
+ * Get the second part of envVar
+ * @param envVar to be split
+ * @param separator of the split
+ */
+export function get_second_part(envVar: string, separator: string): string {
+  return envVar.replace(RegExp(`^.*${separator}`), '')
+}
--- a/src/short.ts
+++ b/src/short.ts
@@ -0,0 +1,10 @@
+const SHORT_SHA_SIZE = 8
+
+/**
+ * slug will take envVar and then :
+ * - limit the string size to 8 characters
+ * @param envVar to be slugged
+ */
+export function shortsha(envVar: string): string {
+  return envVar.substring(0, SHORT_SHA_SIZE)
+}
--- a/src/slug.ts
+++ b/src/slug.ts
@@ -1,79 +1,129 @@
 const MAX_SLUG_STRING_SIZE = 63
-const SHORT_SHA_SIZE = 8
+
+/**
+ * slug_cs will take envVar and then :
+ * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
+ * - remove leading `-` characters
+ * - limit the string size to 63 characters
+ * - remove trailing `-` characters
+ * @param envVar to be slugged
+ */
+export function slug_cs(envVar: string): string {
+  return removeTrailingHyphens(
+    removeLeadingHyphens(replaceAnyNonAlphanumericCharacter(envVar)).substring(
+      0,
+      MAX_SLUG_STRING_SIZE
+    )
+  )
+}

 /**
 * slug will take envVar and then :
 * - put the variable content in lower case
- * - replace any character by `-` except `0-9`, `a-z`, and `.`
- * - remove leading and trailing `-` character
+ * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
+ * - remove leading `-` characters
 * - limit the string size to 63 characters
+ * - remove trailing `-` characters
 * @param envVar to be slugged
 */
 export function slug(envVar: string): string {
-  return trailHyphen(
-    replaceAnyNonAlphanumericCaracter(envVar.toLowerCase())
-  ).substring(0, MAX_SLUG_STRING_SIZE)
+  return slug_cs(envVar.toLowerCase())
 }

 /**
- * 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
+ * slugref_cs will take envVar and then :
+ * - remove refs/(heads|tags|pull)/
+ * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
+ * - remove leading `-` characters
 * - limit the string size to 63 characters
+ * - remove trailing `-` characters
+ * @param envVar to be slugged
+ */
+export function slugref_cs(envVar: string): string {
+  return slug_cs(removeRef(envVar))
+}
+
+/**
+ * slugref will take envVar and then :
+ * - remove refs/(heads|tags|pull)/
+ * - put the variable content in lower case
+ * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
+ * - remove leading `-` characters
+ * - limit the string size to 63 characters
+ * - remove trailing `-` characters
 * @param envVar to be slugged
 */
 export function slugref(envVar: string): string {
-  return slug(removeRef(envVar.toLowerCase()))
+  return slugref_cs(envVar.toLowerCase())
 }

 /**
- * slug will take envVar and then :
+ * slugurl_cs will take envVar and then :
+ * - replace any character by `-` except `0-9`, `a-z`
+ * - remove leading `-` characters
+ * - limit the string size to 63 characters
+ * - remove trailing `-` characters
+ * @param envVar to be slugged
+ */
+export function slugurl_cs(envVar: string): string {
+  return slug_cs(replaceAnyNonUrlCharactersWithHyphen(envVar))
+}
+
+/**
+ * slugurl will take envVar and then :
 * - put the variable content in lower case
 * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading 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(replaceAnyDotToHyphen(envVar))
+  return slugurl_cs(envVar.toLowerCase())
 }

 /**
- * slug will take envVar and then :
- * - remove refs/(heads|tags)/
+ * slugurlref_cs will take envVar and then :
+ * - remove refs/(heads|tags|pull)/
+ * - replace any character by `-` except `0-9`, `a-z`
+ * - remove leading `-` characters
+ * - limit the string size to 63 characters
+ * - remove trailing `-` characters
+ * @param envVar to be slugged
+ */
+export function slugurlref_cs(envVar: string): string {
+  return slugurl_cs(removeRef(envVar))
+}
+
+/**
+ * slugurlref will take envVar and then :
+ * - remove refs/(heads|tags|pull)/
 * - put the variable content in lower case
 * - replace any character by `-` except `0-9`, `a-z`
- * - remove leading 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())
 }

-/**
- * 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 removeLeadingHyphens(envVar: string): string {
+  return envVar.replace(RegExp('^-*', 'g'), '')
+}
+function removeTrailingHyphens(envVar: string): string {
+  return envVar.replace(RegExp('-*$', 'g'), '')
 }

-function trailHyphen(envVar: string): string {
-  return envVar.replace(RegExp('^-*', 'g'), '').replace(RegExp('-*$', 'g'), '')
+function replaceAnyNonAlphanumericCharacter(envVar: string): string {
+  return envVar.replace(RegExp('[^a-zA-Z0-9._]', 'g'), '-')
 }

-function replaceAnyNonAlphanumericCaracter(envVar: string): string {
-  return envVar.replace(RegExp('[^a-z0-9.]', 'g'), '-')
+function replaceAnyNonUrlCharactersWithHyphen(envVar: string): string {
+  return envVar.replace(RegExp('[._]', 'g'), '-')
 }

-function replaceAnyDotToHyphen(envVar: string): string {
-  return envVar.replace(RegExp('[.]', 'g'), '-')
-}
-
-function removeRef(envVar: string): string {
-  return envVar.replace(RegExp('^refs/(heads|tags)/'), '')
+export function removeRef(envVar: string): string {
+  return envVar.replace(RegExp('^refs/(heads|tags|pull)/'), '')
 }
Author	SHA1	Message	Date
semantic-release-bot	1bf76b7bc6	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`))	2022-08-22 21:11:18 +00:00
rlespinasse	46a738e36b	ci: use checkout v3	2022-08-22 23:07:07 +02:00
Romain Lespinasse	82da1fd43c	ci(release): use github token	2022-08-22 23:02:40 +02:00
rlespinasse	99afdf4551	ci: use semantic release action v3	2022-08-22 22:58:21 +02:00
rlespinasse	944fee4603	ci: remove release dry-run	2022-06-16 22:26:11 +02:00
rlespinasse	19f9c84ac6	fix: remove trailing hyphens if any after cut	2022-06-16 22:26:11 +02:00
rlespinasse	596b602d8a	docs(README): improve the overwrite troubleshooting section	2022-04-16 19:25:35 +02:00
Romain Lespinasse	b98d94bda3	ci: remove unused workflow	2022-04-07 20:50:05 +02:00
Romain Lespinasse	e8c1f6060b	ci: rename workflows used on v3 only	2022-04-07 20:49:21 +02:00
Romain Lespinasse	f80aa0fae4	tests: add more test cases on v3 around underscore	2022-04-07 20:35:46 +02: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
semantic-release-bot	e4699e49fc	chore(release): 3.1.0 [skip ci] # [3.1.0](http://github.com/rlespinasse/github-slug-action/compare/3.0.0...3.1.0) (2020-11-01) ### Features * action: improve marketplace information ([`3cddc4f`](`3cddc4f12d`))	2020-11-01 19:40:26 +00:00
Romain Lespinasse	3cddc4f12d	feat(action): improve marketplace information	2020-11-01 20:39:24 +01:00
rlespinasse	d7817bf204	docs(contributing): improve issue links	2020-10-31 16:12:03 +01:00
Romain Lespinasse	4e3f956c5e	docs: add contributing guide	2020-10-31 09:36:05 +01:00
Romain Lespinasse	f79727b5cc	docs: improve master EOL section	2020-10-31 08:24:38 +01:00
Romain Lespinasse	a3c7c5c7a1	docs: use v3.x branch in example	2020-10-31 08:22:11 +01:00
rlespinasse	008aa6260d	build: bump dev dependencies versions	2020-10-27 09:28:24 +01:00
rlespinasse	3c7ae42a01	ci: activate release on v3.x branch	2020-10-26 21:42:08 +01:00
Romain Lespinasse	ae2430ad57	docs(security): remove v1.1.x from supported versions	2020-10-26 21:29:58 +01:00