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))
feat: allow underscore in slug values
2026-05-18 02:45:04 +00:00 · 2021-03-30 20:05:12 +00:00 · 2021-03-30 22:04:00 +02:00 · 2021-03-02 23:30:23 +00:00 · 2021-03-03 00:29:09 +01:00 · 2021-02-27 22:37:18 +01:00
53 changed files with 30765 additions and 1464 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/.editorconfig
+++ b/.editorconfig
@@ -0,0 +1,11 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
--- a/.eslintignore
+++ b/.eslintignore
@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -0,0 +1,54 @@
+{
+    "plugins": ["jest", "@typescript-eslint"],
+    "extends": ["plugin:github/recommended"],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "ecmaVersion": 9,
+      "sourceType": "module",
+      "project": "./tsconfig.json"
+    },
+    "rules": {
+      "eslint-comments/no-use": "off",
+      "import/no-namespace": "off",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": "error",
+      "@typescript-eslint/explicit-member-accessibility": ["error", {"accessibility": "no-public"}],
+      "@typescript-eslint/no-require-imports": "error",
+      "@typescript-eslint/array-type": "error",
+      "@typescript-eslint/await-thenable": "error",
+      "@typescript-eslint/ban-ts-comment": "error",
+      "camelcase": "off",
+      "@typescript-eslint/consistent-type-assertions": "error",
+      "@typescript-eslint/explicit-function-return-type": ["error", {"allowExpressions": true}],
+      "@typescript-eslint/func-call-spacing": ["error", "never"],
+      "@typescript-eslint/no-array-constructor": "error",
+      "@typescript-eslint/no-empty-interface": "error",
+      "@typescript-eslint/no-explicit-any": "error",
+      "@typescript-eslint/no-extraneous-class": "error",
+      "@typescript-eslint/no-for-in-array": "error",
+      "@typescript-eslint/no-inferrable-types": "error",
+      "@typescript-eslint/no-misused-new": "error",
+      "@typescript-eslint/no-namespace": "error",
+      "@typescript-eslint/no-non-null-assertion": "warn",
+      "@typescript-eslint/no-unnecessary-qualifier": "error",
+      "@typescript-eslint/no-unnecessary-type-assertion": "error",
+      "@typescript-eslint/no-useless-constructor": "error",
+      "@typescript-eslint/no-var-requires": "error",
+      "@typescript-eslint/prefer-for-of": "warn",
+      "@typescript-eslint/prefer-function-type": "warn",
+      "@typescript-eslint/prefer-includes": "error",
+      "@typescript-eslint/prefer-string-starts-ends-with": "error",
+      "@typescript-eslint/promise-function-async": "error",
+      "@typescript-eslint/require-array-sort-compare": "error",
+      "@typescript-eslint/restrict-plus-operands": "error",
+      "semi": "off",
+      "@typescript-eslint/semi": ["error", "never"],
+      "@typescript-eslint/type-annotation-spacing": "error",
+      "@typescript-eslint/unbound-method": "error"
+    },
+    "env": {
+      "node": true,
+      "es6": true,
+      "jest/globals": true
+    }
+  }
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: rlespinasse
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
--- a/.github/actions/bats/Dockerfile
+++ b/.github/actions/bats/Dockerfile
@@ -1,5 +0,0 @@
-FROM dduportal/bats:latest
-
-COPY entrypoint.sh /entrypoint.sh
-
-ENTRYPOINT ["/entrypoint.sh"]
--- a/.github/actions/bats/entrypoint.sh
+++ b/.github/actions/bats/entrypoint.sh
@@ -1,3 +0,0 @@
-#!/usr/bin/env sh
-
-/sbin/bats ./tests
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -0,0 +1,131 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - v3.x
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: |
+          npm ci
+      - run: |
+          npm run all
+      - uses: cycjimmy/semantic-release-action@v2
+        with:
+          semantic_version: 17.3.4
+          branches: |
+            [
+              'v2.x',
+              'v3.x'
+            ]
+          extra_plugins: |
+            @semantic-release/changelog@5.0.1
+            @semantic-release/git@9.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN  }}
+
+  os-test:
+    runs-on: ${{ matrix.os  }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+      - name: Output
+        run: |
+          echo "Partial variables"
+          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART }}"
+          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART }}"
+          echo "Slug variables"
+          echo "   repository          : ${{ env.GITHUB_REPOSITORY_SLUG }}"
+          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG }}"
+          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG }}"
+          echo "   ref                 : ${{ env.GITHUB_REF_SLUG }}"
+          echo "   head ref            : ${{ env.GITHUB_HEAD_REF_SLUG }}"
+          echo "   base ref            : ${{ env.GITHUB_BASE_REF_SLUG }}"
+          echo "   event ref           : ${{ env.GITHUB_EVENT_REF_SLUG }}"
+          echo "Slug URL variables"
+          echo "   repository          : ${{ env.GITHUB_REPOSITORY_SLUG_URL }}"
+          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL }}"
+          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL }}"
+          echo "   ref                 : ${{ env.GITHUB_REF_SLUG_URL }}"
+          echo "   head ref            : ${{ env.GITHUB_HEAD_REF_SLUG_URL }}"
+          echo "   base ref            : ${{ env.GITHUB_BASE_REF_SLUG_URL }}"
+          echo "   event ref           : ${{ env.GITHUB_EVENT_REF_SLUG_URL }}"
+          echo "Short SHA variables"
+          echo "   sha                 : ${{ env.GITHUB_SHA_SHORT }}"
+          echo "   pull request sha    : ${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}"
+      - name: Case Sensitive Output
+        run: |
+          echo "Slug variables"
+          echo "   repository          : ${{ env.GITHUB_REPOSITORY_SLUG_CS }}"
+          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_CS }}"
+          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_CS }}"
+          echo "   ref                 : ${{ env.GITHUB_REF_SLUG_CS }}"
+          echo "   head ref            : ${{ env.GITHUB_HEAD_REF_SLUG_CS }}"
+          echo "   base ref            : ${{ env.GITHUB_BASE_REF_SLUG_CS }}"
+          echo "   event ref           : ${{ env.GITHUB_EVENT_REF_SLUG_CS }}"
+          echo "Slug URL variables"
+          echo "   repository          : ${{ env.GITHUB_REPOSITORY_SLUG_URL_CS }}"
+          echo "   repository owner    : ${{ env.GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS }}"
+          echo "   repository name     : ${{ env.GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS }}"
+          echo "   ref                 : ${{ env.GITHUB_REF_SLUG_URL_CS }}"
+          echo "   head ref            : ${{ env.GITHUB_HEAD_REF_SLUG_URL_CS }}"
+          echo "   base ref            : ${{ env.GITHUB_BASE_REF_SLUG_URL_CS }}"
+          echo "   event ref           : ${{ env.GITHUB_EVENT_REF_SLUG_URL_CS }}"
+
+  win-test:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+      - name: Output
+        run: |
+          echo "Partial variables"
+          echo "   repository owner    : $env:GITHUB_REPOSITORY_OWNER_PART"
+          echo "   repository name     : $env:GITHUB_REPOSITORY_NAME_PART"
+          echo "Slug variables"
+          echo "   repository          : $env:GITHUB_REPOSITORY_SLUG"
+          echo "   repository owner    : $env:GITHUB_REPOSITORY_OWNER_PART_SLUG"
+          echo "   repository name     : $env:GITHUB_REPOSITORY_NAME_PART_SLUG"
+          echo "   ref                 : $env:GITHUB_REF_SLUG"
+          echo "   head ref            : $env:GITHUB_HEAD_REF_SLUG"
+          echo "   base ref            : $env:GITHUB_BASE_REF_SLUG"
+          echo "   event ref           : $env:GITHUB_EVENT_REF_SLUG"
+          echo "Slug URL variables"
+          echo "   repository          : $env:GITHUB_REPOSITORY_SLUG_URL"
+          echo "   repository owner    : $env:GITHUB_REPOSITORY_OWNER_PART_SLUG_URL"
+          echo "   repository name     : $env:GITHUB_REPOSITORY_NAME_PART_SLUG_URL"
+          echo "   ref                 : $env:GITHUB_REF_SLUG_URL"
+          echo "   head ref            : $env:GITHUB_HEAD_REF_SLUG_URL"
+          echo "   base ref            : $env:GITHUB_BASE_REF_SLUG_URL"
+          echo "   event ref           : $env:GITHUB_EVENT_REF_SLUG_URL"
+          echo "Short SHA variables"
+          echo "   sha                 : $env:GITHUB_SHA_SHORT"
+          echo "   pull request sha    : $env:GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT"
+      - name: Case Sensitive Output
+        run: |
+          echo "Slug variables"
+          echo "   repository          : $env:GITHUB_REPOSITORY_SLUG_CS"
+          echo "   repository owner    : $env:GITHUB_REPOSITORY_OWNER_PART_SLUG_CS"
+          echo "   repository name     : $env:GITHUB_REPOSITORY_NAME_PART_SLUG_CS"
+          echo "   ref                 : $env:GITHUB_REF_SLUG_CS"
+          echo "   head ref            : $env:GITHUB_HEAD_REF_SLUG_CS"
+          echo "   base ref            : $env:GITHUB_BASE_REF_SLUG_CS"
+          echo "   event ref           : $env:GITHUB_EVENT_REF_SLUG_CS"
+          echo "Slug URL variables"
+          echo "   repository          : $env:GITHUB_REPOSITORY_SLUG_URL_CS"
+          echo "   repository owner    : $env:GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS"
+          echo "   repository name     : $env:GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS"
+          echo "   ref                 : $env:GITHUB_REF_SLUG_URL_CS"
+          echo "   head ref            : $env:GITHUB_HEAD_REF_SLUG_URL_CS"
+          echo "   base ref            : $env:GITHUB_BASE_REF_SLUG_URL_CS"
+          echo "   event ref           : $env:GITHUB_EVENT_REF_SLUG_URL_CS"
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,16 +0,0 @@
-name: ci
-on: push
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: ./.github/actions/bats
-      - uses: cycjimmy/semantic-release-action@v2
-        if: github.ref == 'refs/heads/master'
-        with:
-          extra_plugins: |
-            @semantic-release/git
-            @semantic-release/changelog
-        env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -0,0 +1,34 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ v3.x, v*.x ]
+  pull_request:
+    branches: [ v3.x ]
+  schedule:
+    - cron: '0 6 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1
--- a/.github/workflows/linter.yml
+++ b/.github/workflows/linter.yml
@@ -0,0 +1,31 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - v3.x
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Lint Code Base
+        uses: github/super-linter@v3
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_JAVASCRIPT_STANDARD: false
+          VALIDATE_TYPESCRIPT_STANDARD: false
+          LINTER_RULES_PATH: .
+          JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json
+          JAVASCRIPT_DEFAULT_STYLE: prettier
+          DEFAULT_BRANCH: v3.x
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          FILTER_REGEX_INCLUDE: .*src/.*
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,99 @@
-node_modules/
+# Dependency directory
+node_modules
+
+# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# OS metadata
+.DS_Store
+Thumbs.db
+
+# Ignore built ts files
+__tests__/runner/*
+lib/**/*
--- a/.prettierignore
+++ b/.prettierignore
@@ -0,0 +1,3 @@
+dist/
+lib/
+node_modules/
--- a/.prettierrc.json
+++ b/.prettierrc.json
@@ -0,0 +1,10 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "bracketSpacing": false,
+  "arrowParens": "avoid"
+}
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,6 +1,65 @@
-## [1.0.2](http://github.com/rlespinasse/github-slug-action/compare/1.0.1...1.0.2) (2019-11-06)
+# [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

-* manage branch with slash properly ([c35fd20](http://github.com/rlespinasse/github-slug-action/commit/c35fd2094f6f0cb6c4858cf6db020eedd535671d))
+* support pull-request for slug and slug url ([78985f8](http://github.com/rlespinasse/github-slug-action/commit/78985f84eca97ef1c5262e85e8a73a277494c4ed))
+
+
+### Features
+
+* support partial GITHUB_REPOSITORY ([75ce03b](http://github.com/rlespinasse/github-slug-action/commit/75ce03b6a055a3be9d936a3a99c51038bd72298c))
+
+# [3.2.0](http://github.com/rlespinasse/github-slug-action/compare/3.1.0...3.2.0) (2021-01-12)
+
+
+### Features
+
+* expose GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT ([5b9fe60](http://github.com/rlespinasse/github-slug-action/commit/5b9fe6015d2facc71c81d53bf3b08f04e0f3f743))
+
+# [3.1.0](http://github.com/rlespinasse/github-slug-action/compare/3.0.0...3.1.0) (2020-11-01)
+
+
+### Features
+
+* **action:** improve marketplace information ([3cddc4f](http://github.com/rlespinasse/github-slug-action/commit/3cddc4f12d7a6fdbb8b1221dc02a2c64670e54bf))
+
+# [3.0.0](http://github.com/rlespinasse/github-slug-action/compare/2.1.0...3.0.0) (2020-10-26)
+
+
+### Bug Fixes
+
+* upgrade actions core due to CVE fix ([d0549c1](http://github.com/rlespinasse/github-slug-action/commit/d0549c1f85ab9567b439f9d660b01ce1142b9fbe))
+
+
+### Features
+
+* add support for windows and macos jobs ([13c2f38](http://github.com/rlespinasse/github-slug-action/commit/13c2f38dad5f32529f37c25736412b1e4cf687fe))
+
+
+### BREAKING CHANGES
+
+* The action implementation move from container action to node.js action
+
+Co-authored-by: Romain Lespinasse <romain.lespinasse@gmail.com>
+
+# [2.1.0](http://github.com/rlespinasse/github-slug-action/compare/2.0.0...2.1.0) (2020-07-28)
+
+
+### Features
+
+* expose slug variables for github.event.ref ([5a334a8](http://github.com/rlespinasse/github-slug-action/commit/5a334a8573fc27451af5b2a6ee175d8e11579e10))
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at romain.lespinasse@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
--- 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.
+
+## 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
@@ -0,0 +1,26 @@
+# Developers guide
+
+Install the dependencies
+
+```bash
+npm install
+```
+
+Build the typescript and package it for distribution
+
+```bash
+npm run build && npm run package
+```
+
+Run the tests
+
+```bash
+$ npm test
+
+ PASS  ./index.test.js
+  ✓ throws invalid number (3ms)
+  ✓ wait 500 ms (504ms)
+  ✓ test runs (95ms)
+
+...
+```
--- a/8
+++ b/8
@@ -1,8 +0,0 @@
-# Container image that runs your code
-FROM alpine:3.10
-
-# Copies your code file from your action repository to the filesystem path `/` of the container
-COPY entrypoint.sh /entrypoint.sh
-
-# Code file to execute when the docker container starts up (`entrypoint.sh`)
-ENTRYPOINT ["/entrypoint.sh"]
--- a/4
+++ b/4
@@ -1,6 +1,6 @@
 MIT License

-Copyright (c) 2019 Romain Lespinasse
+Copyright (c) 2019-2020 Romain Lespinasse

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
--- a/README.md
+++ b/README.md
@@ -1,29 +1,182 @@
 # GitHub Slug action

-This action slug and expose some github variables.
+[![Actions Status][1]][2]
+![GitHub Super-Linter][13]
+[![Public workflows that use this action.][8]][9]
+[![Licence][11]][12]

-`Slug` a variable will
+This GitHub Action will expose the slug/short values of [some GitHub environment variables][10] inside your GitHub workflow.

- put the variable content in lower case,
- replace any caracter by `-` except `0-9` and `a-z`,
- remove leading and trailing `-` caracter,
- limit the string size to 63 caracters.
+## Table of Contents

-## Environement Variables
+- [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)
+    - [Partial variables](#partial-variables)
+    - [Slug variables](#slug-variables)
+    - [Slug URL variables](#slug-url-variables)
+    - [Short variables](#short-variables)
+  - [Contribute](#contribute)
+  - [Troubleshooting](#troubleshooting)
+    - [One of environement variable don't work as intended](#one-of-environement-variable-dont-work-as-intended)
+    - [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)

-| GitHub environment variable | Slug variable |
-| - | - |
-| GITHUB_REF | GITHUB_REF_SLUG |
-| GITHUB_HEAD_REF | GITHUB_HEAD_REF_SLUG |
-| GITHUB_BASE_REF | GITHUB_BASE_REF_SLUG |
+## Overview

-## Example usage
+`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
+- limit the string size to 63 characters
+
+<details>
+  <summary>Others <b>Slug-ish</b> commands are available</summary>
+  <p>
+
+- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL (Like `SLUG` but `.` is also replaced by `-`)
+- `SHORT` on a variable will limit the string size to 8 characters (useful for _sha_ value)
+- `<KEY>_PART` on a variable will give a part of a variable defined by a key
+_ `<VAR>_CS` on others variables to keep the value case-sensitive
+
+  </p>
+</details>
+
+## Use this action
+
+Add this in your workflow

 ```yaml
- uses: rlespinasse/github-slug-action@master
- name: Print slug variables
-  run: |
-    echo ${{ env.GITHUB_REF_SLUG }}
-    echo ${{ env.GITHUB_HEAD_REF_SLUG }}
-    echo ${{ env.GITHUB_BASE_REF_SLUG }}
+- name: Inject slug/short variables
+  uses: rlespinasse/github-slug-action@v3.x
 ```
+
+Check for more [examples][3] (OS usage, URL use, ...)
+
+**Tip:** Use [Dependabot][14] to maintain your `github-slug-action` version updated in your GitHub workflows.
+
+## Available Environment variables
+
+**Note**: If you don't find what you search for, read more about [available `GitHub` variables](docs/github-variables.md), and propose a [new custom variable][5].
+
+### Partial variables
+
+| Variable                                                                               | Partial version of | Description                                            |
+| -------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------ |
+| [GITHUB_REPOSITORY_OWNER_PART](docs/partial-variables.md#github_repository_owner_part) | GITHUB_REPOSITORY  | The Owner part of GITHUB_REPOSITORY variable           |
+| [GITHUB_REPOSITORY_NAME_PART](docs/partial-variables.md#github_repository_name_part)   | GITHUB_REPOSITORY  | The Repository name part of GITHUB_REPOSITORY variable |
+
+### Slug variables
+
+**NOTE:** `_CS` suffix available
+
+| Variable                                                                                          | Slug version of              | Description                                                                                         |
+| ------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------- |
+| [GITHUB_REPOSITORY_SLUG](docs/slug-variables.md#github_repository_slug)                           | GITHUB_REPOSITORY            | The owner and repository name.                                                                      |
+| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG](docs/slug-variables.md#github_repository_owner_part_slug) | GITHUB_REPOSITORY_OWNER_PART | The owner name.                                                                                     |
+| [GITHUB_REPOSITORY<br>_NAME_PART_SLUG](docs/slug-variables.md#github_repository_name_part_slug)   | GITHUB_REPOSITORY_NAME_PART  | The repository name.                                                                                |
+| [GITHUB_REF_SLUG](docs/slug-variables.md#github_ref_slug)                                         | GITHUB_REF                   | The branch or tag ref that triggered the workflow.                                                  |
+| [GITHUB_HEAD_REF_SLUG](docs/slug-variables.md#github_head_ref_slug)                               | GITHUB_HEAD_REF              | The branch of the head repository.<br>Only set for [pull-request][4] event and forked repositories. |
+| [GITHUB_BASE_REF_SLUG](docs/slug-variables.md#github_base_ref_slug)                               | GITHUB_BASE_REF              | The branch of the base repository.<br>Only set for [pull-request][4] event and forked repositories. |
+| [GITHUB_EVENT_REF_SLUG](docs/slug-variables.md#github_event_ref_slug)                             | _github.event.ref_           | <br>Only set for [following webhook events][4]<ul><li>`create`</li><li>`delete`</li></ul>           |
+
+### Slug URL variables
+
+**NOTE:** `_CS` suffix available
+
+| Variable                                                                                                  | Slug URL version of          | Description                                                                                         |
+| --------------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------- |
+| [GITHUB_REPOSITORY_SLUG_URL](docs/slug-url-variables.md#github_repository_slug_url)                       | GITHUB_REPOSITORY            | The owner and repository name.                                                                      |
+| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG_URL](docs/slug-variables.md#github_repository_owner_part_slug_url) | GITHUB_REPOSITORY_OWNER_PART | The owner name.                                                                                     |
+| [GITHUB_REPOSITORY<br>_NAME_PART_SLUG_URL](docs/slug-variables.md#github_repository_name_part_slug_url)   | GITHUB_REPOSITORY_NAME_PART  | The repository name.                                                                                |
+| [GITHUB_REF_SLUG_URL](docs/slug-url-variables.md#github_ref_slug_url)                                     | GITHUB_REF                   | The branch or tag ref that triggered the workflow.                                                  |
+| [GITHUB_HEAD_REF_SLUG_URL](docs/slug-url-variables.md#github_head_ref_slug_url)                           | GITHUB_HEAD_REF              | The branch of the head repository.<br>Only set for [pull-request][4] event and forked repositories. |
+| [GITHUB_BASE_REF_SLUG_URL](docs/slug-url-variables.md#github_base_ref_slug_url)                           | GITHUB_BASE_REF              | The branch of the base repository.<br>Only set for [pull-request][4] event and forked repositories. |
+| [GITHUB_EVENT_REF_SLUG_URL](docs/slug-url-variables.md#github_event_ref_slug_url)                         | _github.event.ref_           | <br>Only set for [following webhook events][4]<ul><li>`create`</li><li>`delete`</li></ul>           |
+
+### Short variables
+
+| Variable                                                                                                             | Short version of                             | Description                                                                                                                                                                                                                           |
+| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [GITHUB_SHA_SHORT](docs/short-variables.md#github_sha_short)                                                         | GITHUB_SHA                                   | The commit SHA that triggered the workflow.                                                                                                                                                                                           |
+| [GITHUB_EVENT<br>_PULL_REQUEST<br>_HEAD_SHA_SHORT](docs/short-variables.md#github_event_pull_request_head_sha_short) | _github.event<br>.pull_request<br>.head.sha_ | The commit SHA on pull request that trigger workflow.<br>Only set for [following webhook events][4]<ul><li>`pull_request`</li><li>`pull_request_review`</li><li>`pull_request_review_comment`</li><li>`pull_request_target`</li></ul> |
+
+## Contribute
+
+Follow [Developers guide](DEVELOPERS.md)
+
+## Troubleshooting
+
+### One of environement variable don't work as intended
+
+[**Note**][17]: GitHub reserves the `GITHUB_` environment variable prefix for internal use by GitHub. Setting an environment variable or secret with the `GITHUB_` prefix will result in an error.
+
+Currently, a GitHub workflow setting a `GITHUB_` variable don't ended up in error.
+And if a custom `GITHUB_` variable is in conflict with an official `GITHUB_` variable, the offical `GITHUB_` variable will override custom one.
+
+<details>
+  <summary>Test workflow</summary>
+  <p>
+
+```yaml
+name: Test
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo ${GITHUB_REF}
+      # print "refs/heads/v3.x"
+      - run: echo "GITHUB_REF=one_value" >> "$GITHUB_ENV"
+      - run: echo ${GITHUB_REF}
+      # print "refs/heads/v3.x"
+      - run: echo "GITHUB_REF_SLUG=another_value" >> "$GITHUB_ENV"
+      - run: echo ${GITHUB_REF_SLUG}
+      # print "another_value"
+```
+
+  </p>
+</details>
+
+### An action could not be found at the URI
+
+If your workflow fail on the `Set up job` task with this kind of log :
+
+```text
+Download action repository 'rlespinasse/github-slug-action@master'
+##[error]An action could not be found at the URI 'https://api.github.com/repos/rlespinasse/github-slug-action/tarball/master'
+```
+
+> The master branch don't exists anymore.
+>
+> The master branch EOL have been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][7])
+
+Please, use the current branch `v3.x` or a version tag (see [releases pages][6]) in order to fix your workflow.
+
+## Thanks for talking about us
+
+- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][15] (in french :fr:)
+- [Github Actions : enfin des pipelines accessibles aux développeurs][16] (in french :fr:)
+- The next one is you. _Don't hesitate to add you to this list._
+
+[1]: https://github.com/rlespinasse/github-slug-action/workflows/Build/badge.svg
+[2]: https://github.com/rlespinasse/github-slug-action/actions
+[3]: https://github.com/rlespinasse/github-slug-action/tree/v3.x/examples
+[4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
+[5]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+[6]: https://github.com/rlespinasse/github-slug-action/releases
+[7]: https://github.com/rlespinasse/github-slug-action/issues/15
+[8]: https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Drlespinasse%2Fgithub-slug-action%26badge%3Dtrue
+[9]: https://github.com/search?o=desc&q=rlespinasse/github-slug-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code
+[10]: https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables
+[11]: https://img.shields.io/github/license/rlespinasse/github-slug-action
+[12]: https://github.com/rlespinasse/github-slug-action/blob/v3.x/LICENSE
+[13]: https://github.com/rlespinasse/github-slug-action/workflows/Lint/badge.svg
+[14]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot
+[15]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8
+[16]: https://www.youtube.com/watch?v=RHnTJBwcE98
+[17]:
+https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions and Branches
+
+| Version | Branch | Supported          |
+|---------|--------|--------------------|
+| 3.x     | v3.x   | :white_check_mark: |
+| 2.x     | v2.x   | :white_check_mark: |
+| 1.1.x   | v1.1.x | :x:                |
+| < 1.x   |        | :x:                |
+
+A GitHub repository can used one of the available branches as action inside its workflows.
+
+## Reporting a Vulnerability
+
+You can report a Vulnerability by [my email](mailto:romain.lespinasse@gmail.com).
+
+_Vulnerability stages :_
+
+- Reported,
+- Confirmed (or declined),
+- Fixed on maintained version series.
+
+After a vulnerability fix, an GitHub issue will be created as document this vulnerability.
--- 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
@@ -0,0 +1,10 @@
+import {shortsha} from '../src/short'
+
+function test_short_sha(input: string, expected: string) {
+  let actual = shortsha(input)
+  expect(actual).toEqual(expected)
+}
+
+test('short_sha: long hash', () => {
+  test_short_sha('a35a1a486a260cfd99c5b6f8c6034a2929ba9b3f', 'a35a1a48')
+})
--- a/tests/slug.test.ts
+++ b/tests/slug.test.ts
@@ -0,0 +1,68 @@
+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 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'
+  )
+  test_slug_cs(
+    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+  )
+})
+
+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'
+  )
+  test_slug_cs(
+    '-an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters-',
+    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+  )
+})
--- a/tests/slugref.test.ts
+++ b/tests/slugref.test.ts
@@ -0,0 +1,67 @@
+import {slugref, slugref_cs} from '../src/slug'
+
+function test_slugref(input: string, expected: string) {
+  let actual = slugref(input)
+  expect(actual).toEqual(expected)
+}
+
+function test_slugref_cs(input: string, expected: string) {
+  let actual = slugref_cs(input)
+  expect(actual).toEqual(expected)
+}
+
+test('slug_ref:: master branch', () => {
+  test_slugref('refs/heads/master', 'master')
+  test_slugref_cs('refs/heads/master', 'master')
+})
+
+test('slug_ref: a feature branch', () => {
+  test_slugref('refs/heads/feat/new_feature', 'feat-new_feature')
+  test_slugref_cs('refs/heads/feat/new_feature', 'feat-new_feature')
+})
+
+test('slug_ref: a fix branch', () => {
+  test_slugref('refs/heads/fix/issue_number', 'fix-issue_number')
+  test_slugref_cs('refs/heads/fix/issue_number', 'fix-issue_number')
+})
+
+test('slug_ref: a simple tag', () => {
+  test_slugref('refs/tags/v1.0.0', 'v1.0.0')
+  test_slugref_cs('refs/tags/v1.0.0', 'v1.0.0')
+})
+
+test('slug_ref: a complex tag', () => {
+  test_slugref('refs/tags/product@1.0.0-rc.2', 'product-1.0.0-rc.2')
+  test_slugref_cs('refs/tags/product@1.0.0-rc.2', 'product-1.0.0-rc.2')
+})
+
+test('slug_ref: a reference with upper case letters', () => {
+  test_slugref('refs/heads/New_Awesome_Product', 'new_awesome_product')
+  test_slugref_cs('refs/heads/New_Awesome_Product', 'New_Awesome_Product')
+})
+
+test('slug_ref: test trailing', () => {
+  test_slugref('refs/heads/-trailing-feat-', 'trailing-feat')
+  test_slugref_cs('refs/heads/-trailing-feat-', 'trailing-feat')
+})
+
+test('slug_ref: test refs inside string', () => {
+  test_slugref('refs/heads/-refs/tags/feature/-', 'refs-tags-feature')
+  test_slugref_cs('refs/heads/-refs/tags/feature/-', 'refs-tags-feature')
+})
+
+test('slug_ref: a very long name', () => {
+  test_slugref(
+    'refs/heads/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_cs(
+    'refs/heads/an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+  )
+})
+
+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
@@ -0,0 +1,52 @@
+import {slugurl, slugurl_cs} from '../src/slug'
+
+function test_slugurl(input: string, expected: string) {
+  let actual = slugurl(input)
+  expect(actual).toEqual(expected)
+}
+
+function test_slugurl_cs(input: string, expected: string) {
+  let actual = slugurl_cs(input)
+  expect(actual).toEqual(expected)
+}
+
+test('slug_url: a word', () => {
+  test_slugurl('word', 'word')
+  test_slugurl_cs('word', 'word')
+})
+
+test('slug_url: a string', () => {
+  test_slugurl('basic-string', 'basic-string')
+  test_slugurl_cs('basic-string', 'basic-string')
+})
+
+test('slug_url: a string in camel case', () => {
+  test_slugurl('camelCase', 'camelcase')
+  test_slugurl_cs('camelCase', 'camelCase')
+})
+
+test('slug_url: a path', () => {
+  test_slugurl('path/to/something', 'path-to-something')
+  test_slugurl_cs('path/to/something', 'path-to-something')
+})
+
+test('slug_url: a number', () => {
+  test_slugurl('4.2', '4-2')
+  test_slugurl_cs('4.2', '4-2')
+})
+
+test('slug_url: trailing', () => {
+  test_slugurl('.path.to.', 'path-to')
+  test_slugurl_cs('.path.to.', 'path-to')
+})
+
+test('slug_url: a very long string', () => {
+  test_slugurl(
+    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'an-awesome-feature-very-very-very-very-very-very-very-long-more'
+  )
+  test_slugurl_cs(
+    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+  )
+})
--- a/tests/slugurlref.test.ts
+++ b/tests/slugurlref.test.ts
@@ -0,0 +1,67 @@
+import {slugurlref, slugurlref_cs} from '../src/slug'
+
+function test_slugurlref(input: string, expected: string) {
+  let actual = slugurlref(input)
+  expect(actual).toEqual(expected)
+}
+
+function test_slugurlref_cs(input: string, expected: string) {
+  let actual = slugurlref_cs(input)
+  expect(actual).toEqual(expected)
+}
+
+test('slug_url_ref: master branch', () => {
+  test_slugurlref('refs/heads/master', 'master')
+  test_slugurlref_cs('refs/heads/master', 'master')
+})
+
+test('slug_url_ref: a feature branch', () => {
+  test_slugurlref('refs/heads/feat/new_feature', 'feat-new-feature')
+  test_slugurlref_cs('refs/heads/feat/new_feature', 'feat-new-feature')
+})
+
+test('slug_url_ref: a fix branch', () => {
+  test_slugurlref('refs/heads/fix/issue_number', 'fix-issue-number')
+  test_slugurlref_cs('refs/heads/fix/issue_number', 'fix-issue-number')
+})
+
+test('slug_url_ref: a simple tag', () => {
+  test_slugurlref('refs/tags/v1.0.0', 'v1-0-0')
+  test_slugurlref_cs('refs/tags/v1.0.0', 'v1-0-0')
+})
+
+test('slug_url_ref: a complex tag', () => {
+  test_slugurlref('refs/tags/product@1.0.0-rc.2', 'product-1-0-0-rc-2')
+  test_slugurlref_cs('refs/tags/product@1.0.0-rc.2', 'product-1-0-0-rc-2')
+})
+
+test('slug_url_ref: a reference with upper case letters', () => {
+  test_slugurlref('refs/heads/New_Awesome_Product', 'new-awesome-product')
+  test_slugurlref_cs('refs/heads/New_Awesome_Product', 'New-Awesome-Product')
+})
+
+test('slug_url_ref: a very long name', () => {
+  test_slugurlref(
+    'refs/heads/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_cs(
+    'refs/heads/an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-moreThan63Characters',
+    'an-awesome-Feature-Very-Very-Very-Very-Very-Very-Very-Long-more'
+  )
+})
+
+test('slug_url_ref: test trailing', () => {
+  test_slugurlref('refs/heads/-an-awesome-Feature-', 'an-awesome-feature')
+  test_slugurlref_cs('refs/heads/-an-awesome-Feature-', 'an-awesome-Feature')
+})
+
+test('slug_url_ref: test trailing with dot', () => {
+  test_slugurlref('refs/heads/.an-awesome-Feature.', 'an-awesome-feature')
+  test_slugurlref_cs('refs/heads/.an-awesome-Feature.', 'an-awesome-Feature')
+})
+
+test('slug_url_ref: on pull-request ref', () => {
+  test_slugurlref('refs/pull/branch', 'branch')
+  test_slugurlref_cs('refs/pull/branch', 'branch')
+})
--- a/action.yml
+++ b/action.yml
@@ -1,9 +1,9 @@
-# action.yml
-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: 'docker'
-  image: 'Dockerfile'
+  using: 'node12'
+  main: 'dist/index.js'
 branding:
-  icon: 'crop'  
-  color: 'orange'
+  icon: "minimize"
+  color: "blue"
--- a/dist/index.js
+++ b/dist/index.js
@@ -0,0 +1,906 @@
+require('./sourcemap-register.js');module.exports =
+/******/ (function(modules, runtime) { // webpackBootstrap
+/******/ 	"use strict";
+/******/ 	// The module cache
+/******/ 	var installedModules = {};
+/******/
+/******/ 	// The require function
+/******/ 	function __webpack_require__(moduleId) {
+/******/
+/******/ 		// Check if module is in cache
+/******/ 		if(installedModules[moduleId]) {
+/******/ 			return installedModules[moduleId].exports;
+/******/ 		}
+/******/ 		// Create a new module (and put it into the cache)
+/******/ 		var module = installedModules[moduleId] = {
+/******/ 			i: moduleId,
+/******/ 			l: false,
+/******/ 			exports: {}
+/******/ 		};
+/******/
+/******/ 		// Execute the module function
+/******/ 		var threw = true;
+/******/ 		try {
+/******/ 			modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
+/******/ 			threw = false;
+/******/ 		} finally {
+/******/ 			if(threw) delete installedModules[moduleId];
+/******/ 		}
+/******/
+/******/ 		// Flag the module as loaded
+/******/ 		module.l = true;
+/******/
+/******/ 		// Return the exports of the module
+/******/ 		return module.exports;
+/******/ 	}
+/******/
+/******/
+/******/ 	__webpack_require__.ab = __dirname + "/";
+/******/
+/******/ 	// the startup function
+/******/ 	function startup() {
+/******/ 		// Load entry module and return exports
+/******/ 		return __webpack_require__(109);
+/******/ 	};
+/******/
+/******/ 	// run startup
+/******/ 	return startup();
+/******/ })
+/************************************************************************/
+/******/ ({
+
+/***/ 87:
+/***/ (function(module) {
+
+module.exports = require("os");
+
+/***/ }),
+
+/***/ 109:
+/***/ (function(__unusedmodule, exports, __webpack_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core = __importStar(__webpack_require__(186));
+const slug_1 = __webpack_require__(565);
+const short_1 = __webpack_require__(213);
+const partial_1 = __webpack_require__(373);
+const SEPARATOR = '/';
+/**
+ * Inputs environments variables keys from Github actions job
+ * see https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
+ */
+const GITHUB_REPOSITORY = 'GITHUB_REPOSITORY';
+const GITHUB_REF = 'GITHUB_REF';
+const GITHUB_HEAD_REF = 'GITHUB_HEAD_REF';
+const GITHUB_BASE_REF = 'GITHUB_BASE_REF';
+const GITHUB_SHA = 'GITHUB_SHA';
+const GITHUB_EVENT_PATH = 'GITHUB_EVENT_PATH';
+/**
+ * Partial outputs environments variables keys
+ */
+const GITHUB_REPOSITORY_OWNER_PART = 'GITHUB_REPOSITORY_OWNER_PART';
+const GITHUB_REPOSITORY_NAME_PART = 'GITHUB_REPOSITORY_NAME_PART';
+/**
+ * Slugged outputs environments variables keys
+ */
+const GITHUB_REPOSITORY_SLUG = 'GITHUB_REPOSITORY_SLUG';
+const GITHUB_REPOSITORY_SLUG_CS = 'GITHUB_REPOSITORY_SLUG_CS';
+const GITHUB_REPOSITORY_OWNER_PART_SLUG = 'GITHUB_REPOSITORY_OWNER_PART_SLUG';
+const GITHUB_REPOSITORY_OWNER_PART_SLUG_CS = 'GITHUB_REPOSITORY_OWNER_PART_SLUG_CS';
+const GITHUB_REPOSITORY_NAME_PART_SLUG = 'GITHUB_REPOSITORY_NAME_PART_SLUG';
+const GITHUB_REPOSITORY_NAME_PART_SLUG_CS = 'GITHUB_REPOSITORY_NAME_PART_SLUG_CS';
+const GITHUB_REF_SLUG = 'GITHUB_REF_SLUG';
+const GITHUB_REF_SLUG_CS = 'GITHUB_REF_SLUG_CS';
+const GITHUB_HEAD_REF_SLUG = 'GITHUB_HEAD_REF_SLUG';
+const GITHUB_HEAD_REF_SLUG_CS = 'GITHUB_HEAD_REF_SLUG_CS';
+const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG';
+const GITHUB_BASE_REF_SLUG_CS = 'GITHUB_BASE_REF_SLUG_CS';
+const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG';
+const GITHUB_EVENT_REF_SLUG_CS = 'GITHUB_EVENT_REF_SLUG_CS';
+/**
+ * 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';
+/**
+ * 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';
+function run() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const eventPath = process.env[GITHUB_EVENT_PATH];
+            if (eventPath) {
+                const eventData = yield Promise.resolve().then(() => __importStar(require(eventPath)));
+                if (eventData.hasOwnProperty('ref')) {
+                    core.exportVariable(GITHUB_EVENT_REF_SLUG, slug_1.slugref(eventData.ref));
+                    core.exportVariable(GITHUB_EVENT_REF_SLUG_CS, slug_1.slugref_cs(eventData.ref));
+                    core.exportVariable(GITHUB_EVENT_REF_SLUG_URL, slug_1.slugurlref(eventData.ref));
+                    core.exportVariable(GITHUB_EVENT_REF_SLUG_URL_CS, slug_1.slugurlref_cs(eventData.ref));
+                }
+                else if (eventData.hasOwnProperty('pull_request')) {
+                    core.exportVariable(GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT, short_1.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);
+        }
+        catch (error) {
+            core.setFailed(error.message);
+        }
+    });
+}
+function exportFirstPart(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, partial_1.get_first_part(envVar, separator));
+    }
+}
+function exportSecondPart(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, partial_1.get_second_part(envVar, separator));
+    }
+}
+function exportSlugCS(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, slug_1.slug_cs(envVar));
+    }
+}
+function exportSlug(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, slug_1.slug(envVar));
+    }
+}
+function exportFirstPartSlugCS(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        const value = partial_1.get_first_part(envVar, separator);
+        core.exportVariable(outputKey, slug_1.slug_cs(value));
+    }
+}
+function exportFirstPartSlug(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        const value = partial_1.get_first_part(envVar, separator);
+        core.exportVariable(outputKey, slug_1.slug(value));
+    }
+}
+function exportSecondPartSlugCS(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        const value = partial_1.get_second_part(envVar, separator);
+        core.exportVariable(outputKey, slug_1.slug_cs(value));
+    }
+}
+function exportSecondPartSlug(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        const value = partial_1.get_second_part(envVar, separator);
+        core.exportVariable(outputKey, slug_1.slug(value));
+    }
+}
+function exportSlugRefCS(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, slug_1.slugref_cs(envVar));
+    }
+}
+function exportSlugRef(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, slug_1.slugref(envVar));
+    }
+}
+function exportSlugUrlCS(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, slug_1.slugurl_cs(envVar));
+    }
+}
+function exportSlugUrl(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, slug_1.slugurl(envVar));
+    }
+}
+function exportFirstPartSlugUrlCS(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        const value = partial_1.get_first_part(envVar, separator);
+        core.exportVariable(outputKey, slug_1.slugurl_cs(value));
+    }
+}
+function exportFirstPartSlugUrl(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        const value = partial_1.get_first_part(envVar, separator);
+        core.exportVariable(outputKey, slug_1.slugurl(value));
+    }
+}
+function exportSecondPartSlugUrlCS(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        const value = partial_1.get_second_part(envVar, separator);
+        core.exportVariable(outputKey, slug_1.slugurl_cs(value));
+    }
+}
+function exportSecondPartSlugUrl(inputKey, separator, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        const value = partial_1.get_second_part(envVar, separator);
+        core.exportVariable(outputKey, slug_1.slugurl(value));
+    }
+}
+function exportSlugUrlRefCS(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, slug_1.slugurlref_cs(envVar));
+    }
+}
+function exportSlugUrlRef(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, slug_1.slugurlref(envVar));
+    }
+}
+function exportShortSha(inputKey, outputKey) {
+    const envVar = process.env[inputKey];
+    if (envVar) {
+        core.exportVariable(outputKey, short_1.shortsha(envVar));
+    }
+}
+run();
+
+
+/***/ }),
+
+/***/ 186:
+/***/ (function(__unusedmodule, exports, __webpack_require__) {
+
+"use strict";
+
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = __webpack_require__(351);
+const file_command_1 = __webpack_require__(717);
+const utils_1 = __webpack_require__(278);
+const os = __importStar(__webpack_require__(87));
+const path = __importStar(__webpack_require__(622));
+/**
+ * The code to exit an action
+ */
+var ExitCode;
+(function (ExitCode) {
+    /**
+     * A code indicating that the action was successful
+     */
+    ExitCode[ExitCode["Success"] = 0] = "Success";
+    /**
+     * A code indicating that the action was a failure
+     */
+    ExitCode[ExitCode["Failure"] = 1] = "Failure";
+})(ExitCode = exports.ExitCode || (exports.ExitCode = {}));
+//-----------------------------------------------------------------------
+// Variables
+//-----------------------------------------------------------------------
+/**
+ * Sets env variable for this action and future actions in the job
+ * @param name the name of the variable to set
+ * @param val the value of the variable. Non-string values will be converted to a string via JSON.stringify
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function exportVariable(name, val) {
+    const convertedVal = utils_1.toCommandValue(val);
+    process.env[name] = convertedVal;
+    const filePath = process.env['GITHUB_ENV'] || '';
+    if (filePath) {
+        const delimiter = '_GitHubActionsFileCommandDelimeter_';
+        const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`;
+        file_command_1.issueCommand('ENV', commandValue);
+    }
+    else {
+        command_1.issueCommand('set-env', { name }, convertedVal);
+    }
+}
+exports.exportVariable = exportVariable;
+/**
+ * Registers a secret which will get masked from logs
+ * @param secret value of the secret
+ */
+function setSecret(secret) {
+    command_1.issueCommand('add-mask', {}, secret);
+}
+exports.setSecret = setSecret;
+/**
+ * Prepends inputPath to the PATH (for this action and future actions)
+ * @param inputPath
+ */
+function addPath(inputPath) {
+    const filePath = process.env['GITHUB_PATH'] || '';
+    if (filePath) {
+        file_command_1.issueCommand('PATH', inputPath);
+    }
+    else {
+        command_1.issueCommand('add-path', {}, inputPath);
+    }
+    process.env['PATH'] = `${inputPath}${path.delimiter}${process.env['PATH']}`;
+}
+exports.addPath = addPath;
+/**
+ * Gets the value of an input.  The value is also trimmed.
+ *
+ * @param     name     name of the input to get
+ * @param     options  optional. See InputOptions.
+ * @returns   string
+ */
+function getInput(name, options) {
+    const val = process.env[`INPUT_${name.replace(/ /g, '_').toUpperCase()}`] || '';
+    if (options && options.required && !val) {
+        throw new Error(`Input required and not supplied: ${name}`);
+    }
+    return val.trim();
+}
+exports.getInput = getInput;
+/**
+ * Sets the value of an output.
+ *
+ * @param     name     name of the output to set
+ * @param     value    value to store. Non-string values will be converted to a string via JSON.stringify
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function setOutput(name, value) {
+    command_1.issueCommand('set-output', { name }, value);
+}
+exports.setOutput = setOutput;
+/**
+ * Enables or disables the echoing of commands into stdout for the rest of the step.
+ * Echoing is disabled by default if ACTIONS_STEP_DEBUG is not set.
+ *
+ */
+function setCommandEcho(enabled) {
+    command_1.issue('echo', enabled ? 'on' : 'off');
+}
+exports.setCommandEcho = setCommandEcho;
+//-----------------------------------------------------------------------
+// Results
+//-----------------------------------------------------------------------
+/**
+ * Sets the action status to failed.
+ * When the action exits it will be with an exit code of 1
+ * @param message add error issue message
+ */
+function setFailed(message) {
+    process.exitCode = ExitCode.Failure;
+    error(message);
+}
+exports.setFailed = setFailed;
+//-----------------------------------------------------------------------
+// Logging Commands
+//-----------------------------------------------------------------------
+/**
+ * Gets whether Actions Step Debug is on or not
+ */
+function isDebug() {
+    return process.env['RUNNER_DEBUG'] === '1';
+}
+exports.isDebug = isDebug;
+/**
+ * Writes debug message to user log
+ * @param message debug message
+ */
+function debug(message) {
+    command_1.issueCommand('debug', {}, message);
+}
+exports.debug = debug;
+/**
+ * Adds an error issue
+ * @param message error issue message. Errors will be converted to string via toString()
+ */
+function error(message) {
+    command_1.issue('error', message instanceof Error ? message.toString() : message);
+}
+exports.error = error;
+/**
+ * Adds an warning issue
+ * @param message warning issue message. Errors will be converted to string via toString()
+ */
+function warning(message) {
+    command_1.issue('warning', message instanceof Error ? message.toString() : message);
+}
+exports.warning = warning;
+/**
+ * Writes info to log with console.log.
+ * @param message info message
+ */
+function info(message) {
+    process.stdout.write(message + os.EOL);
+}
+exports.info = info;
+/**
+ * Begin an output group.
+ *
+ * Output until the next `groupEnd` will be foldable in this group
+ *
+ * @param name The name of the output group
+ */
+function startGroup(name) {
+    command_1.issue('group', name);
+}
+exports.startGroup = startGroup;
+/**
+ * End an output group.
+ */
+function endGroup() {
+    command_1.issue('endgroup');
+}
+exports.endGroup = endGroup;
+/**
+ * Wrap an asynchronous function call in a group.
+ *
+ * Returns the same type as the function itself.
+ *
+ * @param name The name of the group
+ * @param fn The function to wrap in the group
+ */
+function group(name, fn) {
+    return __awaiter(this, void 0, void 0, function* () {
+        startGroup(name);
+        let result;
+        try {
+            result = yield fn();
+        }
+        finally {
+            endGroup();
+        }
+        return result;
+    });
+}
+exports.group = group;
+//-----------------------------------------------------------------------
+// Wrapper action state
+//-----------------------------------------------------------------------
+/**
+ * Saves state for current action, the state can only be retrieved by this action's post job execution.
+ *
+ * @param     name     name of the state to store
+ * @param     value    value to store. Non-string values will be converted to a string via JSON.stringify
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function saveState(name, value) {
+    command_1.issueCommand('save-state', { name }, value);
+}
+exports.saveState = saveState;
+/**
+ * Gets the value of an state set by this action's main execution.
+ *
+ * @param     name     name of the state to get
+ * @returns   string
+ */
+function getState(name) {
+    return process.env[`STATE_${name}`] || '';
+}
+exports.getState = getState;
+//# sourceMappingURL=core.js.map
+
+/***/ }),
+
+/***/ 213:
+/***/ (function(__unusedmodule, exports) {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shortsha = void 0;
+const SHORT_SHA_SIZE = 8;
+/**
+ * slug will take envVar and then :
+ * - limit the string size to 8 characters
+ * @param envVar to be slugged
+ */
+function shortsha(envVar) {
+    return envVar.substring(0, SHORT_SHA_SIZE);
+}
+exports.shortsha = shortsha;
+
+
+/***/ }),
+
+/***/ 278:
+/***/ (function(__unusedmodule, exports) {
+
+"use strict";
+
+// We use any as a valid input type
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Sanitizes an input into a string so it can be passed into issueCommand safely
+ * @param input input to sanitize into a string
+ */
+function toCommandValue(input) {
+    if (input === null || input === undefined) {
+        return '';
+    }
+    else if (typeof input === 'string' || input instanceof String) {
+        return input;
+    }
+    return JSON.stringify(input);
+}
+exports.toCommandValue = toCommandValue;
+//# sourceMappingURL=utils.js.map
+
+/***/ }),
+
+/***/ 351:
+/***/ (function(__unusedmodule, exports, __webpack_require__) {
+
+"use strict";
+
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const os = __importStar(__webpack_require__(87));
+const utils_1 = __webpack_require__(278);
+/**
+ * Commands
+ *
+ * Command Format:
+ *   ::name key=value,key=value::message
+ *
+ * Examples:
+ *   ::warning::This is the message
+ *   ::set-env name=MY_VAR::some value
+ */
+function issueCommand(command, properties, message) {
+    const cmd = new Command(command, properties, message);
+    process.stdout.write(cmd.toString() + os.EOL);
+}
+exports.issueCommand = issueCommand;
+function issue(name, message = '') {
+    issueCommand(name, {}, message);
+}
+exports.issue = issue;
+const CMD_STRING = '::';
+class Command {
+    constructor(command, properties, message) {
+        if (!command) {
+            command = 'missing.command';
+        }
+        this.command = command;
+        this.properties = properties;
+        this.message = message;
+    }
+    toString() {
+        let cmdStr = CMD_STRING + this.command;
+        if (this.properties && Object.keys(this.properties).length > 0) {
+            cmdStr += ' ';
+            let first = true;
+            for (const key in this.properties) {
+                if (this.properties.hasOwnProperty(key)) {
+                    const val = this.properties[key];
+                    if (val) {
+                        if (first) {
+                            first = false;
+                        }
+                        else {
+                            cmdStr += ',';
+                        }
+                        cmdStr += `${key}=${escapeProperty(val)}`;
+                    }
+                }
+            }
+        }
+        cmdStr += `${CMD_STRING}${escapeData(this.message)}`;
+        return cmdStr;
+    }
+}
+function escapeData(s) {
+    return utils_1.toCommandValue(s)
+        .replace(/%/g, '%25')
+        .replace(/\r/g, '%0D')
+        .replace(/\n/g, '%0A');
+}
+function escapeProperty(s) {
+    return utils_1.toCommandValue(s)
+        .replace(/%/g, '%25')
+        .replace(/\r/g, '%0D')
+        .replace(/\n/g, '%0A')
+        .replace(/:/g, '%3A')
+        .replace(/,/g, '%2C');
+}
+//# sourceMappingURL=command.js.map
+
+/***/ }),
+
+/***/ 373:
+/***/ (function(__unusedmodule, exports) {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get_second_part = exports.get_first_part = void 0;
+/**
+ * Get the first part of envVar
+ * @param envVar to be split
+ * @param separator of the split
+ */
+function get_first_part(envVar, separator) {
+    return envVar.replace(RegExp(`${separator}.*$`), '');
+}
+exports.get_first_part = get_first_part;
+/**
+ * Get the second part of envVar
+ * @param envVar to be split
+ * @param separator of the split
+ */
+function get_second_part(envVar, separator) {
+    return envVar.replace(RegExp(`^.*${separator}`), '');
+}
+exports.get_second_part = get_second_part;
+
+
+/***/ }),
+
+/***/ 565:
+/***/ (function(__unusedmodule, exports) {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.slugurlref = exports.slugurlref_cs = exports.slugurl = exports.slugurl_cs = exports.slugref = exports.slugref_cs = exports.slug = exports.slug_cs = void 0;
+const MAX_SLUG_STRING_SIZE = 63;
+/**
+ * slug_cs will take envVar and then :
+ * - replace any character by `-` except `0-9`, `a-z`, and `.`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+function slug_cs(envVar) {
+    return trailHyphen(replaceAnyNonAlphanumericCharacter(envVar)).substring(0, MAX_SLUG_STRING_SIZE);
+}
+exports.slug_cs = slug_cs;
+/**
+ * slug will take envVar and then :
+ * - put the variable content in lower case
+ * - replace any character by `-` except `0-9`, `a-z`, and `.`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+function slug(envVar) {
+    return slug_cs(envVar.toLowerCase());
+}
+exports.slug = slug;
+/**
+ * slugref_cs will take envVar and then :
+ * - remove refs/(heads|tags|pull)/
+ * - replace any character by `-` except `0-9`, `a-z`, and `.`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+function slugref_cs(envVar) {
+    return slug_cs(removeRef(envVar));
+}
+exports.slugref_cs = slugref_cs;
+/**
+ * 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 and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+function slugref(envVar) {
+    return slugref_cs(envVar.toLowerCase());
+}
+exports.slugref = slugref;
+/**
+ * slugurl_cs will take envVar and then :
+ * - replace any character by `-` except `0-9`, `a-z`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+function slugurl_cs(envVar) {
+    return slug_cs(replaceAnyDotToHyphen(envVar));
+}
+exports.slugurl_cs = slugurl_cs;
+/**
+ * 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
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+function slugurl(envVar) {
+    return slug(replaceAnyDotToHyphen(envVar));
+}
+exports.slugurl = slugurl;
+/**
+ * slugurlref_cs will take envVar and then :
+ * - remove refs/(heads|tags|pull)/
+ * - replace any character by `-` except `0-9`, `a-z`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+function slugurlref_cs(envVar) {
+    return slugurl_cs(slugref_cs(envVar));
+}
+exports.slugurlref_cs = slugurlref_cs;
+/**
+ * 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
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+function slugurlref(envVar) {
+    return slugurl(slugref(envVar));
+}
+exports.slugurlref = slugurlref;
+function trailHyphen(envVar) {
+    return envVar.replace(RegExp('^-*', 'g'), '').replace(RegExp('-*$', 'g'), '');
+}
+function replaceAnyNonAlphanumericCharacter(envVar) {
+    return envVar.replace(RegExp('[^a-zA-Z0-9.]', 'g'), '-');
+}
+function replaceAnyDotToHyphen(envVar) {
+    return envVar.replace(RegExp('[.]', 'g'), '-');
+}
+function removeRef(envVar) {
+    return envVar.replace(RegExp('^refs/(heads|tags|pull)/'), '');
+}
+
+
+/***/ }),
+
+/***/ 622:
+/***/ (function(module) {
+
+module.exports = require("path");
+
+/***/ }),
+
+/***/ 717:
+/***/ (function(__unusedmodule, exports, __webpack_require__) {
+
+"use strict";
+
+// For internal use, subject to change.
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// We use any as a valid input type
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const fs = __importStar(__webpack_require__(747));
+const os = __importStar(__webpack_require__(87));
+const utils_1 = __webpack_require__(278);
+function issueCommand(command, message) {
+    const filePath = process.env[`GITHUB_${command}`];
+    if (!filePath) {
+        throw new Error(`Unable to find environment variable for file command ${command}`);
+    }
+    if (!fs.existsSync(filePath)) {
+        throw new Error(`Missing file at path: ${filePath}`);
+    }
+    fs.appendFileSync(filePath, `${utils_1.toCommandValue(message)}${os.EOL}`, {
+        encoding: 'utf8'
+    });
+}
+exports.issueCommand = issueCommand;
+//# sourceMappingURL=file-command.js.map
+
+/***/ }),
+
+/***/ 747:
+/***/ (function(module) {
+
+module.exports = require("fs");
+
+/***/ })
+
+/******/ });
+//# sourceMappingURL=index.js.map
--- a/dist/index.js.map
+++ b/dist/index.js.map
--- a/dist/sourcemap-register.js
+++ b/dist/sourcemap-register.js
--- a/docs/github-variables.md
+++ b/docs/github-variables.md
@@ -0,0 +1,96 @@
+# Available GitHub Variables
+
+All `GitHub` variables availables in your workflow in addition of ones exposed by this Action
+
+## Table of Contents
+
+- [Available GitHub Variables](#available-github-variables)
+  - [Table of Contents](#table-of-contents)
+  - [Default environment variables](#default-environment-variables)
+    - [Action-managed Environment Variables](#action-managed-environment-variables)
+  - [Variables from events](#variables-from-events)
+    - [Action-managed Event Variables](#action-managed-event-variables)
+      - [create](#create)
+      - [delete](#delete)
+      - [pull_request](#pull_request)
+      - [pull_request_review](#pull_request_review)
+      - [pull_request_review_comment](#pull_request_review_comment)
+      - [pull_request_target](#pull_request_target)
+
+## Default environment variables
+
+Read the official documentation about [Default environment variables][1].
+
+### Action-managed Environment Variables
+
+| Action-managed Variables | Can be suffix by     |
+| ------------------------ | -------------------- |
+| GITHUB_REPOSITORY        | `_SLUG`, `_SLUG_URL` |
+| GITHUB_REF               | `_SLUG`, `_SLUG_URL` |
+| GITHUB_HEAD_REF          | `_SLUG`, `_SLUG_URL` |
+| GITHUB_BASE_REF          | `_SLUG`, `_SLUG_URL` |
+| GITHUB_SHA               | `_SHORT`             |
+
+## Variables from events
+
+Read the official documentation about [Events that trigger workflows][2].
+
+### Action-managed Event Variables
+
+#### create
+
+Checkout [create][3] webhook payload content
+
+| Action-managed Variables | Available as              |
+| ------------------------ | ------------------------- |
+| github.event.ref         | GITHUB_EVENT_REF_SLUG     |
+| github.event.ref         | GITHUB_EVENT_REF_SLUG_URL |
+
+#### delete
+
+Checkout [delete][4] webhook payload content
+
+| Action-managed Variables | Available as              |
+| ------------------------ | ------------------------- |
+| github.event.ref         | GITHUB_EVENT_REF_SLUG     |
+| github.event.ref         | GITHUB_EVENT_REF_SLUG_URL |
+
+#### pull_request
+
+Checkout [pull_request][5] webhook payload content
+
+| Action-managed Variables           | Available as                             |
+| ---------------------------------- | ---------------------------------------- |
+| github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
+
+#### pull_request_review
+
+Checkout [pull_request_review][6] webhook payload content
+
+| Action-managed Variables           | Available as                             |
+| ---------------------------------- | ---------------------------------------- |
+| github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
+
+#### pull_request_review_comment
+
+Checkout [pull_request_review_comment][7] webhook payload content
+
+| Action-managed Variables           | Available as                             |
+| ---------------------------------- | ---------------------------------------- |
+| github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
+
+#### pull_request_target
+
+Checkout [pull_request][5] webhook payload content
+
+| Action-managed Variables           | Available as                             |
+| ---------------------------------- | ---------------------------------------- |
+| github.event.pull_request.head.sha | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
+
+[1]: https://docs.github.com/en/actions/reference/environment-variables#default-environment-variables
+[2]: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
+[3]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#create
+[4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#delete
+[5]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request
+[6]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review
+[7]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review_comment
--- a/docs/partial-variables.md
+++ b/docs/partial-variables.md
@@ -0,0 +1,28 @@
+# Partial Variables
+
+## Table of Contents
+
+- [Partial Variables](#partial-variables)
+  - [Table of Contents](#table-of-contents)
+  - [GITHUB_REPOSITORY_OWNER_PART](#github_repository_owner_part)
+  - [GITHUB_REPOSITORY_NAME_PART](#github_repository_name_part)
+
+## GITHUB_REPOSITORY_OWNER_PART
+
+Owner part of the environment variable **GITHUB_REPOSITORY**
+
+| GITHUB_REPOSITORY            | GITHUB_REPOSITORY_OWNER_PART |
+| ---------------------------- | ---------------------------- |
+| octocat/Hello-World          | octocat                      |
+| rlespinasse/Hello-World.go   | rlespinasse                  |
+| AnotherPerson/SomeRepository | AnotherPerson                |
+
+## GITHUB_REPOSITORY_NAME_PART
+
+Repository name part of the environment variable **GITHUB_REPOSITORY**
+
+| GITHUB_REPOSITORY            | GITHUB_REPOSITORY_NAME_PART |
+| ---------------------------- | --------------------------- |
+| octocat/Hello-World          | Hello-World                 |
+| rlespinasse/Hello-World.go   | Hello-World.go              |
+| AnotherPerson/SomeRepository | SomeRepository              |
--- a/docs/short-variables.md
+++ b/docs/short-variables.md
@@ -0,0 +1,27 @@
+# Short Variables
+
+## Table of Contents
+
+- [Short Variables](#short-variables)
+  - [Table of Contents](#table-of-contents)
+  - [GITHUB_SHA_SHORT](#github_sha_short)
+  - [GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT](#github_event_pull_request_head_sha_short)
+
+## GITHUB_SHA_SHORT
+
+Short the environment variable **GITHUB_SHA**
+
+The commit SHA that triggered the workflow
+
+| GITHUB_SHA                               | GITHUB_SHA_SHORT |
+| ---------------------------------------- | ---------------- |
+| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e         |
+
+## GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT
+
+Short the value of `github.event.pull_request.head.sha` that represents the last commit
+used for triggering an action for a pull request.
+
+| github.event.pull_request.head.sha       | GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT |
+| ---------------------------------------- | ---------------------------------------- |
+| ffac537e6cbbf934b08745a378932722df287a53 | ffac537e                                 |
--- a/docs/slug-url-variables.md
+++ b/docs/slug-url-variables.md
@@ -0,0 +1,109 @@
+# Slug URL Variables
+
+## Table of Contents
+
+- [Slug URL Variables](#slug-url-variables)
+  - [Table of Contents](#table-of-contents)
+  - [GITHUB_REPOSITORY_SLUG_URL](#github_repository_slug_url)
+  - [GITHUB_REPOSITORY_OWNER_PART_SLUG_URL](#github_repository_owner_part_slug_url)
+  - [GITHUB_REPOSITORY_NAME_PART_SLUG_URL](#github_repository_name_part_slug_url)
+  - [GITHUB_REF_SLUG_URL](#github_ref_slug_url)
+  - [GITHUB_HEAD_REF_SLUG_URL](#github_head_ref_slug_url)
+  - [GITHUB_BASE_REF_SLUG_URL](#github_base_ref_slug_url)
+  - [GITHUB_EVENT_REF_SLUG_URL](#github_event_ref_slug_url)
+
+## GITHUB_REPOSITORY_SLUG_URL
+
+Slug URL the environment variable **GITHUB_REPOSITORY**
+
+The owner and repository name.
+
+| GITHUB_REPOSITORY            | GITHUB_REPOSITORY_SLUG_URL   |
+| ---------------------------- | ---------------------------- |
+| octocat/Hello-World          | octocat-hello-world          |
+| rlespinasse/Hello-World.go   | rlespinasse-hello-world-go   |
+| AnotherPerson/SomeRepository | anotherperson-somerepository |
+
+## GITHUB_REPOSITORY_OWNER_PART_SLUG_URL
+
+Slug URL the environment variable [GITHUB_REPOSITORY_OWNER_PART](partial-variables.md#github_repository_owner_part)
+
+The Owner part of **GITHUB_REPOSITORY** variable.
+
+| GITHUB_REPOSITORY_OWNER_PART | GITHUB_REPOSITORY_OWNER_PART_SLUG_URL |
+| ---------------------------- | ------------------------------------- |
+| octocat                      | octocat                               |
+| rlespinasse                  | rlespinasse                           |
+| AnotherPerson                | anotherperson                         |
+
+## GITHUB_REPOSITORY_NAME_PART_SLUG_URL
+
+Slug URL the environment variable [GITHUB_REPOSITORY_NAME_PART](partial-variables.md#github_repository_name_part)
+
+The Repository name part of **GITHUB_REPOSITORY** variable.
+
+| GITHUB_REPOSITORY_NAME_PART | GITHUB_REPOSITORY_NAME_PART_SLUG_URL |
+| --------------------------- | ------------------------------------ |
+| Hello-World                 | hello-world                          |
+| Hello-World.go              | hello-world-go                       |
+| SomeRepository              | somerepository                       |
+
+## GITHUB_REF_SLUG_URL
+
+Slug URL the environment variable **GITHUB_REF**
+
+The branch or tag ref that triggered the workflow.
+_If neither a branch or tag is available for the event type, the variable will not exist._
+
+| GITHUB_REF                     | GITHUB_REF_SLUG_URL |
+| ------------------------------ | ------------------- |
+| refs/heads/main                | main                |
+| refs/heads/feat/new_feature    | feat-new-feature    |
+| refs/tags/v1.0.0               | v1-0-0              |
+| refs/pull/42-merge             | 42-merge            |
+| refs/tags/product@1.0.0-rc.2   | product-1-0-0-rc-2  |
+| refs/heads/New_Awesome_Product | new-awesome-product |
+
+**Caution**: From v3.0.0 to v3.2.0 included, `GITHUB_REF_SLUG` have the wrong value on `pull_request` event.
+`refs/pull/42-merge` become `refs-pull-42-merge` instead of `42-merge`. The bug have been fixed in v3.3.0
+
+## GITHUB_HEAD_REF_SLUG_URL
+
+Slug URL the environment variable **GITHUB_HEAD_REF**
+
+The branch of the head repository.
+_Only set for forked repositories._
+
+| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG_URL |
+| ------------------------------ | ------------------------ |
+| refs/heads/main                | main                     |
+| refs/heads/feat/new_feature    | feat-new-feature         |
+| refs/heads/New_Awesome_Product | new-awesome-product      |
+
+## GITHUB_BASE_REF_SLUG_URL
+
+Slug URL the environment variable **GITHUB_BASE_REF**
+
+The branch of the base repository.
+_Only set for forked repositories._
+
+| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG_URL |
+| ------------------------------ | ------------------------ |
+| refs/heads/main                | main                     |
+| refs/heads/feat/new_feature    | feat-new-feature         |
+| refs/heads/New_Awesome_Product | new-awesome-product      |
+
+## GITHUB_EVENT_REF_SLUG_URL
+
+Slug URL the variable **github.event.ref**
+
+The git reference resource associated to triggered webhook.
+_Only set for [`create`, and `delete`][1] events._
+
+| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG_URL |
+| ------------------------------ | ------------------------ |
+| refs/heads/main                | main                     |
+| refs/heads/feat/new_feature    | feat-new-feature         |
+| refs/heads/New_Awesome_Product | new-awesome-product      |
+
+[1]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
--- a/docs/slug-variables.md
+++ b/docs/slug-variables.md
@@ -0,0 +1,105 @@
+# Slug Variables
+
+## Table of Contents
+
+- [Slug Variables](#slug-variables)
+  - [Table of Contents](#table-of-contents)
+  - [GITHUB_REPOSITORY_SLUG](#github_repository_slug)
+  - [GITHUB_REPOSITORY_OWNER_PART_SLUG](#github_repository_owner_part_slug)
+  - [GITHUB_REPOSITORY_NAME_PART_SLUG](#github_repository_name_part_slug)
+  - [GITHUB_REF_SLUG](#github_ref_slug)
+  - [GITHUB_HEAD_REF_SLUG](#github_head_ref_slug)
+  - [GITHUB_BASE_REF_SLUG](#github_base_ref_slug)
+  - [GITHUB_EVENT_REF_SLUG](#github_event_ref_slug)
+
+## GITHUB_REPOSITORY_SLUG
+
+Slug the environment variable **GITHUB_REPOSITORY**
+
+The owner and repository name.
+
+| GITHUB_REPOSITORY            | GITHUB_REPOSITORY_SLUG       |
+| ---------------------------- | ---------------------------- |
+| octocat/Hello-World          | octocat-hello-world          |
+| rlespinasse/Hello-World.go   | rlespinasse-hello-world.go   |
+| AnotherPerson/SomeRepository | anotherperson-somerepository |
+
+## GITHUB_REPOSITORY_OWNER_PART_SLUG
+
+Slug the environment variable [GITHUB_REPOSITORY_OWNER_PART](partial-variables.md#github_repository_owner_part)
+
+The Owner part of **GITHUB_REPOSITORY** variable.
+
+| GITHUB_REPOSITORY_OWNER_PART | GITHUB_REPOSITORY_OWNER_PART_SLUG |
+| ---------------------------- | --------------------------------- |
+| octocat                      | octocat                           |
+| rlespinasse                  | rlespinasse                       |
+| AnotherPerson                | anotherperson                     |
+
+## GITHUB_REPOSITORY_NAME_PART_SLUG
+
+Slug the environment variable [GITHUB_REPOSITORY_NAME_PART](partial-variables.md#github_repository_name_part)
+
+The Repository name part of **GITHUB_REPOSITORY** variable.
+
+| GITHUB_REPOSITORY_NAME_PART | GITHUB_REPOSITORY_NAME_PART_SLUG |
+| --------------------------- | -------------------------------- |
+| Hello-World                 | hello-world                      |
+| Hello-World.go              | hello-world.go                   |
+| SomeRepository              | somerepository                   |
+
+## GITHUB_REF_SLUG
+
+Slug the environment variable **GITHUB_REF**
+
+The branch or tag ref that triggered the workflow.
+_If neither a branch or tag is available for the event type, the variable will not exist._
+
+| GITHUB_REF                     | GITHUB_REF_SLUG     |
+| ------------------------------ | ------------------- |
+| refs/heads/main                | main                |
+| refs/heads/feat/new_feature    | feat-new-feature    |
+| refs/tags/v1.0.0               | v1.0.0              |
+| refs/tags/product@1.0.0-rc.2   | product-1.0.0-rc.2  |
+| refs/heads/New_Awesome_Product | new-awesome-product |
+
+## GITHUB_HEAD_REF_SLUG
+
+Slug the environment variable **GITHUB_HEAD_REF**
+
+The branch of the head repository.
+_Only set for [`pull-request`][1] event and forked repositories._
+
+| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG |
+| ------------------------------ | -------------------- |
+| refs/heads/main                | main                 |
+| refs/heads/feat/new_feature    | feat-new-feature     |
+| refs/heads/New_Awesome_Product | new-awesome-product  |
+
+## GITHUB_BASE_REF_SLUG
+
+Slug the environment variable **GITHUB_BASE_REF**
+
+The branch of the base repository.
+_Only set for [`pull-request`][1] event and forked repositories._
+
+| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG |
+| ------------------------------ | -------------------- |
+| refs/heads/main                | main                 |
+| refs/heads/feat/new_feature    | feat-new-feature     |
+| refs/heads/New_Awesome_Product | new-awesome-product  |
+
+## GITHUB_EVENT_REF_SLUG
+
+Slug the variable **github.event.ref**
+
+The git reference resource associated to triggered webhook.
+_Only set for [`create`, and `delete`][1] events._
+
+| GITHUB_REF                     | GITHUB_HEAD_REF_SLUG |
+| ------------------------------ | -------------------- |
+| refs/heads/main                | main                 |
+| refs/heads/feat/new_feature    | feat-new-feature     |
+| refs/heads/New_Awesome_Product | new-awesome-product  |
+
+[1]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
--- a/entrypoint.sh
+++ b/entrypoint.sh
@@ -1,12 +0,0 @@
-#!/bin/sh -l
-
-slug_ref() {
-    echo "$1" \
-         | tr "[:upper:]" "[:lower:]" \
-         | sed -r 's#refs/[^\/]*/##;s/[~\^]+//g;s/[^a-zA-Z0-9]+/-/g;s/^-+\|-+$//g;s/^-*//;s/-*$//' \
-         | cut -c1-63
-}
-
-echo ::set-env name=GITHUB_REF_SLUG::"$(slug_ref "$GITHUB_REF")"
-echo ::set-env name=GITHUB_HEAD_REF_SLUG::"$(slug_ref "$GITHUB_HEAD_REF")"
-echo ::set-env name=GITHUB_BASE_REF_SLUG::"$(slug_ref "$GITHUB_BASE_REF")"
--- 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.mycompany.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.mycompany.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/jest.config.js
+++ b/jest.config.js
@@ -0,0 +1,11 @@
+module.exports = {
+  clearMocks: true,
+  moduleFileExtensions: ['js', 'ts'],
+  testEnvironment: 'node',
+  testMatch: ['**/*.test.ts'],
+  testRunner: 'jest-circus/runner',
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  verbose: true
+}
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -1,19 +1,50 @@
 {
  "name": "github-slug-action",
-  "version": "1.0.1",
+  "version": "0.0.0",
  "license": "MIT",
+  "private": true,
+  "description": "Github slug action",
+  "main": "lib/main.js",
  "scripts": {
-    "test": "docker run -w /workdir -v $(pwd):/workdir dduportal/bats:latest ./tests",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "build": "tsc",
+    "format": "prettier --write **/*.ts",
+    "format-check": "prettier --check **/*.ts",
+    "lint": "eslint src/**/*.ts",
+    "package": "ncc build --source-map",
+    "test": "jest",
+    "all": "npm run build && npm run format && npm run lint && npm run package && npm test"
  },
  "repository": {
    "type": "git",
    "url": "http://github.com/rlespinasse/github-slug-action.git"
  },
+  "keywords": [
+    "actions",
+    "node",
+    "setup"
+  ],
+  "author": "rlespinasse",
+  "dependencies": {
+    "@actions/core": "^1.2.6"
+  },
  "devDependencies": {
-    "@semantic-release/changelog": "^3.0.5",
-    "@semantic-release/git": "^7.0.18",
-    "semantic-release": "^15.13.30"
+    "@semantic-release/changelog": "^5.0.1",
+    "@semantic-release/git": "^9.0.0",
+    "@types/jest": "^26.0.20",
+    "@types/node": "^14.14.21",
+    "@typescript-eslint/parser": "^3.9.1",
+    "@vercel/ncc": "^0.23.0",
+    "eslint": "^7.18.0",
+    "eslint-plugin-github": "^4.1.1",
+    "eslint-plugin-jest": "^23.20.0",
+    "jest": "^26.6.3",
+    "jest-circus": "^26.6.3",
+    "js-yaml": "^3.14.1",
+    "prettier": "^2.2.1",
+    "semantic-release": "^17.4.0",
+    "ts-jest": "^26.4.4",
+    "typescript": "^3.9.7"
  },
  "release": {
    "tagFormat": "${version}",
@@ -23,6 +54,10 @@
      "@semantic-release/changelog",
      "@semantic-release/git",
      "@semantic-release/github"
+    ],
+    "branches": [
+      "v2.x",
+      "v3.x"
    ]
  }
 }
--- a/src/main.ts
+++ b/src/main.ts
@@ -0,0 +1,355 @@
+import * as core from '@actions/core'
+import {
+  slug,
+  slug_cs,
+  slugref,
+  slugref_cs,
+  slugurl,
+  slugurl_cs,
+  slugurlref,
+  slugurlref_cs
+} from './slug'
+import {shortsha} from './short'
+import {get_first_part, get_second_part} from './partial'
+
+const SEPARATOR = '/'
+
+/**
+ * Inputs environments variables keys from Github actions job
+ * see https://docs.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
+ */
+const GITHUB_REPOSITORY = 'GITHUB_REPOSITORY'
+const GITHUB_REF = 'GITHUB_REF'
+const GITHUB_HEAD_REF = 'GITHUB_HEAD_REF'
+const GITHUB_BASE_REF = 'GITHUB_BASE_REF'
+const GITHUB_SHA = 'GITHUB_SHA'
+const GITHUB_EVENT_PATH = 'GITHUB_EVENT_PATH'
+
+/**
+ * Partial outputs environments variables keys
+ */
+const GITHUB_REPOSITORY_OWNER_PART = 'GITHUB_REPOSITORY_OWNER_PART'
+const GITHUB_REPOSITORY_NAME_PART = 'GITHUB_REPOSITORY_NAME_PART'
+
+/**
+ * Slugged outputs environments variables keys
+ */
+const GITHUB_REPOSITORY_SLUG = 'GITHUB_REPOSITORY_SLUG'
+const GITHUB_REPOSITORY_SLUG_CS = 'GITHUB_REPOSITORY_SLUG_CS'
+const GITHUB_REPOSITORY_OWNER_PART_SLUG = 'GITHUB_REPOSITORY_OWNER_PART_SLUG'
+const GITHUB_REPOSITORY_OWNER_PART_SLUG_CS =
+  'GITHUB_REPOSITORY_OWNER_PART_SLUG_CS'
+const GITHUB_REPOSITORY_NAME_PART_SLUG = 'GITHUB_REPOSITORY_NAME_PART_SLUG'
+const GITHUB_REPOSITORY_NAME_PART_SLUG_CS =
+  'GITHUB_REPOSITORY_NAME_PART_SLUG_CS'
+const GITHUB_REF_SLUG = 'GITHUB_REF_SLUG'
+const GITHUB_REF_SLUG_CS = 'GITHUB_REF_SLUG_CS'
+const GITHUB_HEAD_REF_SLUG = 'GITHUB_HEAD_REF_SLUG'
+const GITHUB_HEAD_REF_SLUG_CS = 'GITHUB_HEAD_REF_SLUG_CS'
+const GITHUB_BASE_REF_SLUG = 'GITHUB_BASE_REF_SLUG'
+const GITHUB_BASE_REF_SLUG_CS = 'GITHUB_BASE_REF_SLUG_CS'
+const GITHUB_EVENT_REF_SLUG = 'GITHUB_EVENT_REF_SLUG'
+const GITHUB_EVENT_REF_SLUG_CS = 'GITHUB_EVENT_REF_SLUG_CS'
+
+/**
+ * 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'
+
+/**
+ * Shorted outputs environments variables keys
+ */
+const GITHUB_SHA_SHORT = 'GITHUB_SHA_SHORT'
+const GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT =
+  'GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT'
+
+async function run(): Promise<void> {
+  try {
+    const eventPath = process.env[GITHUB_EVENT_PATH]
+    if (eventPath) {
+      const eventData = await import(eventPath)
+      if (eventData.hasOwnProperty('ref')) {
+        core.exportVariable(GITHUB_EVENT_REF_SLUG, slugref(eventData.ref))
+        core.exportVariable(GITHUB_EVENT_REF_SLUG_CS, slugref_cs(eventData.ref))
+        core.exportVariable(
+          GITHUB_EVENT_REF_SLUG_URL,
+          slugurlref(eventData.ref)
+        )
+        core.exportVariable(
+          GITHUB_EVENT_REF_SLUG_URL_CS,
+          slugurlref_cs(eventData.ref)
+        )
+      } else if (eventData.hasOwnProperty('pull_request')) {
+        core.exportVariable(
+          GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT,
+          shortsha(eventData.pull_request.head.sha)
+        )
+      }
+    }
+
+    exportFirstPart(GITHUB_REPOSITORY, SEPARATOR, GITHUB_REPOSITORY_OWNER_PART)
+    exportSecondPart(GITHUB_REPOSITORY, SEPARATOR, GITHUB_REPOSITORY_NAME_PART)
+
+    exportSlug(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG)
+    exportSlugCS(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_CS)
+    exportFirstPartSlug(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_OWNER_PART_SLUG
+    )
+    exportFirstPartSlugCS(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_OWNER_PART_SLUG_CS
+    )
+    exportSecondPartSlug(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_NAME_PART_SLUG
+    )
+    exportSecondPartSlugCS(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_NAME_PART_SLUG_CS
+    )
+
+    exportSlugUrl(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_URL)
+    exportSlugUrlCS(GITHUB_REPOSITORY, GITHUB_REPOSITORY_SLUG_URL_CS)
+    exportFirstPartSlugUrl(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_OWNER_PART_SLUG_URL
+    )
+    exportFirstPartSlugUrlCS(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_OWNER_PART_SLUG_URL_CS
+    )
+    exportSecondPartSlugUrl(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_NAME_PART_SLUG_URL
+    )
+    exportSecondPartSlugUrlCS(
+      GITHUB_REPOSITORY,
+      SEPARATOR,
+      GITHUB_REPOSITORY_NAME_PART_SLUG_URL_CS
+    )
+
+    exportSlugRef(GITHUB_REF, GITHUB_REF_SLUG)
+    exportSlugRefCS(GITHUB_REF, GITHUB_REF_SLUG_CS)
+    exportSlugRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG)
+    exportSlugRefCS(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_CS)
+    exportSlugRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG)
+    exportSlugRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_CS)
+
+    exportSlugUrlRef(GITHUB_REF, GITHUB_REF_SLUG_URL)
+    exportSlugUrlRefCS(GITHUB_REF, GITHUB_REF_SLUG_URL_CS)
+    exportSlugUrlRef(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_URL)
+    exportSlugUrlRefCS(GITHUB_HEAD_REF, GITHUB_HEAD_REF_SLUG_URL_CS)
+    exportSlugUrlRef(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL)
+    exportSlugUrlRefCS(GITHUB_BASE_REF, GITHUB_BASE_REF_SLUG_URL_CS)
+
+    exportShortSha(GITHUB_SHA, GITHUB_SHA_SHORT)
+  } 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) {
+    core.exportVariable(outputKey, slug(envVar))
+  }
+}
+
+function exportFirstPartSlugCS(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_first_part(envVar, separator)
+    core.exportVariable(outputKey, slug_cs(value))
+  }
+}
+
+function exportFirstPartSlug(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_first_part(envVar, separator)
+    core.exportVariable(outputKey, slug(value))
+  }
+}
+
+function exportSecondPartSlugCS(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_second_part(envVar, separator)
+    core.exportVariable(outputKey, slug_cs(value))
+  }
+}
+
+function exportSecondPartSlug(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_second_part(envVar, separator)
+    core.exportVariable(outputKey, slug(value))
+  }
+}
+
+function exportSlugRefCS(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, slugref_cs(envVar))
+  }
+}
+
+function exportSlugRef(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, slugref(envVar))
+  }
+}
+
+function exportSlugUrlCS(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, slugurl_cs(envVar))
+  }
+}
+function exportSlugUrl(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, slugurl(envVar))
+  }
+}
+
+function exportFirstPartSlugUrlCS(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_first_part(envVar, separator)
+    core.exportVariable(outputKey, slugurl_cs(value))
+  }
+}
+
+function exportFirstPartSlugUrl(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_first_part(envVar, separator)
+    core.exportVariable(outputKey, slugurl(value))
+  }
+}
+
+function exportSecondPartSlugUrlCS(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_second_part(envVar, separator)
+    core.exportVariable(outputKey, slugurl_cs(value))
+  }
+}
+
+function exportSecondPartSlugUrl(
+  inputKey: string,
+  separator: string,
+  outputKey: string
+): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    const value = get_second_part(envVar, separator)
+    core.exportVariable(outputKey, slugurl(value))
+  }
+}
+
+function exportSlugUrlRefCS(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    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))
+  }
+}
+
+function exportShortSha(inputKey: string, outputKey: string): void {
+  const envVar = process.env[inputKey]
+  if (envVar) {
+    core.exportVariable(outputKey, shortsha(envVar))
+  }
+}
+
+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
@@ -0,0 +1,116 @@
+const MAX_SLUG_STRING_SIZE = 63
+
+/**
+ * slug_cs will take envVar and then :
+ * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+export function slug_cs(envVar: string): string {
+  return trailHyphen(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
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+export function slug(envVar: string): string {
+  return slug_cs(envVar.toLowerCase())
+}
+
+/**
+ * slugref_cs will take envVar and then :
+ * - remove refs/(heads|tags|pull)/
+ * - replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 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 and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+export function slugref(envVar: string): string {
+  return slugref_cs(envVar.toLowerCase())
+}
+
+/**
+ * slugurl_cs will take envVar and then :
+ * - replace any character by `-` except `0-9`, `a-z`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 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
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+export function slugurl(envVar: string): string {
+  return slug(replaceAnyNonUrlCharactersWithHyphen(envVar))
+}
+
+/**
+ * slugurlref_cs will take envVar and then :
+ * - remove refs/(heads|tags|pull)/
+ * - replace any character by `-` except `0-9`, `a-z`
+ * - remove leading and trailing `-` character
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+export function slugurlref_cs(envVar: string): string {
+  return slugurl_cs(slugref_cs(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
+ * - limit the string size to 63 characters
+ * @param envVar to be slugged
+ */
+export function slugurlref(envVar: string): string {
+  return slugurl(slugref(envVar))
+}
+
+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 replaceAnyNonUrlCharactersWithHyphen(envVar: string): string {
+  return envVar.replace(RegExp('[._]', 'g'), '-')
+}
+
+function removeRef(envVar: string): string {
+  return envVar.replace(RegExp('^refs/(heads|tags|pull)/'), '')
+}
--- a/tests/slug_ref.bats
+++ b/tests/slug_ref.bats
@@ -1,55 +0,0 @@
-#!/usr/bin/env bats
-
-@test "Slug master branch" {
-  test_sluf_ref \
-    "refs/heads/master" \
-    "master"
-}
-
-@test "Slug a feature branch" {
-  test_sluf_ref \
-    "refs/heads/feat/new_feature" \
-    "feat-new-feature"
-}
-
-@test "Slug a fix branch" {
-  test_sluf_ref \
-    "refs/heads/fix/issue_number" \
-    "fix-issue-number"
-}
-
-@test "Slug a simple tag" {
-  test_sluf_ref \
-    "refs/tags/v1.0.0" \
-    "v1-0-0"
-}
-
-@test "Slug a complex tag" {
-  test_sluf_ref \
-    "refs/tags/product@1.0.0-rc.2" \
-    "product-1-0-0-rc-2"
-}
-
-@test "Slug a reference with upper case letters" {
-  test_sluf_ref \
-    "refs/heads/New_Awesome_Product" \
-    "new-awesome-product"
-}
-
-@test "Slug a very long name" {
-  test_sluf_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"
-}
-
-# Load sluf_ref function
-source entrypoint.sh > /dev/null 2>&1
-
-test_sluf_ref() {
-  given="${1}"
-  expected="${2}"
-
-  actual="$(slug_ref \"${given}\")"
-  echo "expected : [${expected}], actual : [${actual}]"
-  [ "${actual}" == "${expected}" ]
-}
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "outDir": "./lib",                        /* Redirect output structure to the directory. */
+    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+  },
+  "exclude": ["node_modules", "**/*.test.ts"]
+}
Author	SHA1	Message	Date
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
semantic-release-bot	6a873bec5a	chore(release): 3.0.0 [skip ci] # [3.0.0](http://github.com/rlespinasse/github-slug-action/compare/2.1.0...3.0.0) (2020-10-26) ### Bug Fixes * upgrade actions core due to CVE fix ([`d0549c1`](`d0549c1f85`)) ### Features * add support for windows and macos jobs ([`13c2f38`](`13c2f38dad`)) ### BREAKING CHANGES * The action implementation move from container action to node.js action Co-authored-by: Romain Lespinasse <romain.lespinasse@gmail.com>	2020-10-26 20:27:51 +00:00
Romain Lespinasse	749009dfe1	ci: activate release on v3.x branch	2020-10-26 21:26:45 +01:00
rlespinasse	ec03dc4d9c	build: add dist files after actions core upgrades	2020-10-18 20:09:34 +02:00
rlespinasse	d0549c1f85	fix: upgrade actions core due to CVE fix	2020-10-07 22:53:33 +02:00
Antoine Méausoone	13c2f38dad	feat: add support for windows and macos jobs BREAKING CHANGE: The action implementation move from container action to node.js action Co-authored-by: Romain Lespinasse <romain.lespinasse@gmail.com>	2020-09-26 09:07:49 +02:00
dependabot[bot]	6efa53ebca	build(deps): bump node-fetch from 2.6.0 to 2.6.1 Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1. - [Release notes](https://github.com/bitinn/node-fetch/releases) - [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md) - [Commits](https://github.com/bitinn/node-fetch/compare/v2.6.0...v2.6.1) Signed-off-by: dependabot[bot] <support@github.com>	2020-09-12 17:41:09 +02:00
Romain Lespinasse	c0eae81222	style: use markdown syntax on link with image	2020-08-28 15:21:44 +02:00
Antoine Méausoone	7e9b2916a8	docs: add badge with number of public users	2020-08-26 19:20:17 +02:00
Romain Lespinasse	c34e0866d5	docs: improve troubleshooting section	2020-08-25 12:38:58 +02:00
rlespinasse	9ed3b31f8a	ci: update release dependencies	2020-08-16 21:06:07 +02:00
semantic-release-bot	1172ed1802	chore(release): 2.1.0 [skip ci] # [2.1.0](http://github.com/rlespinasse/github-slug-action/compare/2.0.0...2.1.0) (2020-07-28) ### Features * expose slug variables for github.event.ref ([`5a334a8`](`5a334a8573`))	2020-07-28 16:50:05 +00:00
rlespinasse	5a334a8573	feat: expose slug variables for github.event.ref	2020-07-28 18:49:15 +02:00
Romain Lespinasse	4268cc0475	docs: add funding file	2020-07-20 20:26:41 +02:00
Romain Lespinasse	9225a8adaf	docs: add troubleshooting section	2020-07-17 22:31:08 +02:00
rlespinasse	498f51bdf6	chore: update package json for security reason	2020-07-15 23:35:55 +02:00
rlespinasse	7c65a057e0	ci: improve release process	2020-05-01 17:18:08 +02:00
rlespinasse	e5b7d5b5fc	docs: fix typo	2020-04-26 02:25:09 +02:00
rlespinasse	ca9a67fa1f	feat(slug): expose GITHUB_REPOSITORY slugs	2020-04-26 02:12:41 +02:00
rlespinasse	e95fe45d8b	feat(slug): keep period in slug variable BREAKING CHANGE: The previous slug function is rename slug_url to be able to still use itin the subdomain of an url. Co-authored-by: Marc Schiller <m4rc.schiller@gmail.com>	2020-04-26 02:12:28 +02:00
rlespinasse	250b75dc58	ci: introduce version 2.x serie	2020-04-25 23:17:37 +02:00
rlespinasse	8799f16714	docs(security): add vulenerability report guide	2020-04-25 22:23:43 +02:00
rlespinasse	f55abd0ed8	docs: improve usage guide	2020-04-25 22:04:15 +02:00
rlespinasse	78b4cbe021	style: add editorconfig file	2020-04-25 22:04:15 +02:00
rlespinasse	74fe20250f	ci: move to branch-based releases	2020-04-25 19:56:36 +02:00
rlespinasse	30ff8f2cb0	build: fix dependencies vulnerabilities	2020-04-25 19:43:46 +02:00
Slava Semushin	73f6003cd2	style: fix typos	2019-12-16 17:18:57 +01:00
dependabot[bot]	fd2f7856b9	build(deps): bump npm from 6.13.0 to 6.13.4 Bumps [npm](https://github.com/npm/cli) from 6.13.0 to 6.13.4. - [Release notes](https://github.com/npm/cli/releases) - [Changelog](https://github.com/npm/cli/blob/latest/CHANGELOG.md) - [Commits](https://github.com/npm/cli/compare/v6.13.0...v6.13.4) Signed-off-by: dependabot[bot] <support@github.com>	2019-12-13 22:32:17 +01:00
Antoine Meausoone	0e25ff1b4e	ci(pr): build on pull_request	2019-12-11 13:23:09 +01:00
Antoine Méausoone	97aa7af437	test(docker): fix bats docker image	2019-12-11 13:23:09 +01:00
semantic-release-bot	881085bcae	chore(release): 1.1.0 [skip ci] # [1.1.0](http://github.com/rlespinasse/github-slug-action/compare/1.0.2...1.1.0) (2019-11-11) ### Features * short_sha: add a shortened sha commit id ([`d77acd4`](`d77acd4f47`))	2019-11-11 14:54:29 +00:00
Antoine Méausoone	d77acd4f47	feat(short_sha): add a shortened sha commit id	2019-11-11 15:53:51 +01:00
Romain Lespinasse	3876a4c025	docs: add github issues templates	2019-11-07 12:26:13 +01:00
Romain Lespinasse	41d11115fa	docs: add a code of conduct	2019-11-07 12:23:07 +01:00
Antoine Méausoone	01a0df0009	docs: fix typo in readme	2019-11-07 12:21:38 +01:00