chore(release): 3.9.0 [skip ci]

# [3.9.0](https://github.com/rlespinasse/github-slug-action/compare/v3.8.0...v3.9.0) (2024-01-28)

### Features

* use node20 as action run mode ([#138](https://github.com/rlespinasse/github-slug-action/issues/138)) ([26c5c6b](26c5c6b51c))

.dependabot/config.xml

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

.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

.eslintignore

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

.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
+    }
+  }

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: rlespinasse

.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.

.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.

.github/workflows/codeql-analysis.yml

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

.github/workflows/github-slug.yml

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

.github/workflows/release-dryrun.yml

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

.github/workflows/release.yml

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

.gitignore

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

.prettierignore

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

.prettierrc.json

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

CHANGELOG.md

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

CODE_OF_CONDUCT.md

@@ -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

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# How to contribute to GitHub Slug Action
+
+## Did you find a bug
+
+* **Do not open up a GitHub issue if the bug is a security vulnerability**, and instead to refer to our [security policy][1].
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues][2].
+
+* If you're unable to find an open issue addressing the problem, [open a 'Bug' issue][4].
+Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+## Did you write a patch that fixes a bug
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution.
+Include the relevant issue number if applicable.
+
+## Do you intend to add a new feature or change an existing one
+
+* Suggest your change by [opening a 'Feature request' issue][5] and start writing code (following the [developers guide](DEVELOPERS.md))
+
+## Do you have questions about the source code
+
+* [open an issue][3] with your question.
+
+Thanks!
+
+[1]: https://github.com/rlespinasse/github-slug-action/security/policy
+[2]: https://github.com/rlespinasse/github-slug-action/issues
+[3]: https://github.com/rlespinasse/github-slug-action/issues/new
+[4]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=bug&template=bug_report.md&title=
+[5]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=

DEVELOPERS.md

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

Dockerfile

@@ -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"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

README.md

@@ -1,28 +1,202 @@
 # GitHub Slug action
 
-This action slug and expose some github variables.
+This GitHub Action will expose the slug/short values of [some GitHub environment variables][default-environment-variables] inside your GitHub workflow.
 
-`Slug` a variable will
+## Table of Contents
 
-- put the variable content in lower case,
-- replace any caracter by `-` except `0-9` and `a-z`,
-- limit the string size to 63 caracters
+- [GitHub Slug action](#github-slug-action)
+  - [Table of Contents](#table-of-contents)
+  - [Overview](#overview)
+  - [Use this action](#use-this-action)
+  - [Available Environment variables](#available-environment-variables)
+    - [Enhanced variables](#enhanced-variables)
+    - [Partial variables](#partial-variables)
+    - [Slug variables](#slug-variables)
+    - [Slug URL variables](#slug-url-variables)
+    - [Short variables](#short-variables)
+  - [Contribute](#contribute)
+  - [Troubleshooting](#troubleshooting)
+    - [One of the environment variables doesn't work as intended](#one-of-the-environment-variables-doesnt-work-as-intended)
+      - [Known environment variable conflicts](#known-environment-variable-conflicts)
+        - [GITHUB_REF_NAME](#github_ref_name)
+    - [An action could not be found at the URI](#an-action-could-not-be-found-at-the-uri)
+  - [Thanks for talking about us](#thanks-for-talking-about-us)
 
-## Environement Variables
+## Overview
 
-| GitHub environment variable | Slug variable |
-| - | - |
-| GITHUB_REF | GITHUB_REF_SLUG |
-| GITHUB_HEAD_REF | GITHUB_HEAD_REF_SLUG |
-| GITHUB_BASE_REF | GITHUB_BASE_REF_SLUG |
+`SLUG` on a variable will
 
-## Example usage
+- put the variable content in lower case
+- replace any character by `-` except `0-9`, `a-z`, `.`, and `_`
+- remove leading `-` characters
+- limit the string size to 63 characters
+- remove trailing `-` characters
+
+<details>
+  <summary>Others <b>Slug-ish</b> commands are available</summary>
+  <p>
+
+- `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL
+  - Like `SLUG` but `.` is also replaced by `-`
+- `SHORT` on a variable will limit the string size to 8 characters
+  - Useful for _sha_ value
+- `<KEY>_PART` on a variable will give a part of a variable defined by a key
+  - Like `GITHUB_REPOSITORY_OWNER_PART` for the owner part of `GITHUB_REPOSITORY`
+- `<VAR>_CS` on others variables to keep the value case-sensitive
+  - Like `GITHUB_REF_SLUG_CS`
+
+  </p>
+</details>
+
+Additional enhanced environment variables can be compute to help you around GitHub environment variables.
+
+## Use this action
+
+Add this in your workflow
 
 ```yaml
-- uses: rlespinasse/github-slug-action@1.0.0
-- 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][examples] (OS usage, URL use, ...)
+
+**Tip:** Use [Dependabot][dependabot] to maintain your `github-slug-action` version updated in your GitHub workflows.
+
+## Available Environment variables
+
+**Note**: If you don't find what you search for, read more about [available `GitHub` variables](docs/github-variables.md), and propose a [new custom variable][custom-variable].
+
+### Enhanced variables
+
+- `GITHUB_REF_NAME` will contains the reference name (branch or tag)
+  - based on `GITHUB_HEAD_REF` in a [`pull-request*`][webhooks-and-events] event context,
+  - based on `GITHUB_REF` in others event context.
+
+**NOTE:** All enhanced variables are available in all **slug** formats.
+
+### Partial variables
+
+| Variable                                                                               | Partial version of | Description                                            |
+| -------------------------------------------------------------------------------------- | ------------------ | ------------------------------------------------------ |
+| [GITHUB_REPOSITORY_OWNER_PART](docs/partial-variables.md#github_repository_owner_part) | GITHUB_REPOSITORY  | The Owner part of GITHUB_REPOSITORY variable           |
+| [GITHUB_REPOSITORY_NAME_PART](docs/partial-variables.md#github_repository_name_part)   | GITHUB_REPOSITORY  | The Repository name part of GITHUB_REPOSITORY variable |
+
+### Slug variables
+
+**NOTE:** `_CS` suffix available
+
+| Variable                                                                                          | Slug version of              | Description                                                                                                          |
+| ------------------------------------------------------------------------------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+| [GITHUB_REPOSITORY_SLUG](docs/slug-variables.md#github_repository_slug)                           | GITHUB_REPOSITORY            | The owner and repository name.                                                                                       |
+| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG](docs/slug-variables.md#github_repository_owner_part_slug) | GITHUB_REPOSITORY_OWNER_PART | The owner name.                                                                                                      |
+| [GITHUB_REPOSITORY<br>_NAME_PART_SLUG](docs/slug-variables.md#github_repository_name_part_slug)   | GITHUB_REPOSITORY_NAME_PART  | The repository name.                                                                                                 |
+| [GITHUB_REF_SLUG](docs/slug-variables.md#github_ref_slug)                                         | GITHUB_REF                   | The branch or tag ref that triggered the workflow.                                                                   |
+| [GITHUB_HEAD_REF_SLUG](docs/slug-variables.md#github_head_ref_slug)                               | GITHUB_HEAD_REF              | The branch of the head repository.<br>Only set for [pull-request][event-pull-request] event and forked repositories. |
+| [GITHUB_BASE_REF_SLUG](docs/slug-variables.md#github_base_ref_slug)                               | GITHUB_BASE_REF              | The branch of the base repository.<br>Only set for [pull-request][event-pull-request] event and forked repositories. |
+| [GITHUB_EVENT_REF_SLUG](docs/slug-variables.md#github_event_ref_slug)                             | _github.event.ref_           | <br>Only set for [following webhook events][webhooks-and-events]<ul><li>`create`</li><li>`delete`</li></ul>          |
+
+### Slug URL variables
+
+**NOTE:** `_CS` suffix available
+
+| Variable                                                                                                  | Slug URL version of          | Description                                                                                                           |
+| --------------------------------------------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| [GITHUB_REPOSITORY_SLUG_URL](docs/slug-url-variables.md#github_repository_slug_url)                       | GITHUB_REPOSITORY            | The owner and repository name.                                                                                        |
+| [GITHUB_REPOSITORY<br>_OWNER_PART_SLUG_URL](docs/slug-variables.md#github_repository_owner_part_slug_url) | GITHUB_REPOSITORY_OWNER_PART | The owner name.                                                                                                       |
+| [GITHUB_REPOSITORY<br>_NAME_PART_SLUG_URL](docs/slug-variables.md#github_repository_name_part_slug_url)   | GITHUB_REPOSITORY_NAME_PART  | The repository name.                                                                                                  |
+| [GITHUB_REF_SLUG_URL](docs/slug-url-variables.md#github_ref_slug_url)                                     | GITHUB_REF                   | The branch or tag ref that triggered the workflow.                                                                    |
+| [GITHUB_HEAD_REF_SLUG_URL](docs/slug-url-variables.md#github_head_ref_slug_url)                           | GITHUB_HEAD_REF              | The branch of the head repository.<br>Only set for [pull-request][webhooks-and-events] event and forked repositories. |
+| [GITHUB_BASE_REF_SLUG_URL](docs/slug-url-variables.md#github_base_ref_slug_url)                           | GITHUB_BASE_REF              | The branch of the base repository.<br>Only set for [pull-request][webhooks-and-events] event and forked repositories. |
+| [GITHUB_EVENT_REF_SLUG_URL](docs/slug-url-variables.md#github_event_ref_slug_url)                         | _github.event.ref_           | <br>Only set for [following webhook events][webhooks-and-events]<ul><li>`create`</li><li>`delete`</li></ul>           |
+
+### Short variables
+
+| Variable                                                                                                             | Short version of                             | Description                                                                                                                                                                                                                                             |
+| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [GITHUB_SHA_SHORT](docs/short-variables.md#github_sha_short)                                                         | GITHUB_SHA                                   | The commit SHA that triggered the workflow.                                                                                                                                                                                                             |
+| [GITHUB_EVENT<br>_PULL_REQUEST<br>_HEAD_SHA_SHORT](docs/short-variables.md#github_event_pull_request_head_sha_short) | _github.event<br>.pull_request<br>.head.sha_ | The commit SHA on pull request that trigger workflow.<br>Only set for [following webhook events][webhooks-and-events]<ul><li>`pull_request`</li><li>`pull_request_review`</li><li>`pull_request_review_comment`</li><li>`pull_request_target`</li></ul> |
+
+## Contribute
+
+Follow [Developers guide](DEVELOPERS.md)
+
+## Troubleshooting
+
+### One of the environment variables doesn't work as intended
+
+[**Note**][naming-conventions]: When you set a custom environment variable, you cannot use any of the default environment variable names. For a complete list of these, see [Default environment variables][default-environment-variables]. **If you attempt to override the value of one of these default environment variables, the assignment is ignored.**
+
+If a variable start to be used as default environment variable, the environment variable may have a different behavior than the expected one.
+
+If this append, the `${{ env.GITHUB_AWESOME_VARIABLE }}` and `$GITHUB_AWESOME_VARIABLE` expression will not works in the same way.
+
+- `${{ env.GITHUB_AWESOME_VARIABLE }}` will serve the behavior of this action,
+- `$GITHUB_AWESOME_VARIABLE` will serve the behavior of GitHub Action.
+
+Otherwise the two expression will serve the behavior of this action.
+This will not occurs if you use the `prefix` input to avoid the issue.
+
+**NOTE:** If detected, the maintainers of this action will choose the best course of action depending of the impact.
+
+#### Known environment variable conflicts
+
+##### GITHUB_REF_NAME
+
+The behavior is the same as the GitHub one except on `pull_request*` workflows ([Ready the full story][issue-104]).
+
+- `${{ env.GITHUB_REF_NAME }}` will serve the behavior of this action,
+- `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
+
+On `pull_request*` workflows, the content will be `<PR-number>/merge` instead of the branch name.
+
+A possible workaround is to use `prefix` input available in `v4` version
+
+```yaml
+- name: Inject slug/short variables
+  uses: rlespinasse/github-slug-action@v4
+  with:
+    prefix: CI_
+```
+
+Then `${{ env.CI_GITHUB_REF_NAME }}`, and `$CI_GITHUB_REF_NAME` will serve the behavior of this action.
+And `$GITHUB_REF_NAME` will serve the behavior of GitHub Action.
+
+### An action could not be found at the URI
+
+If your workflow fail on the `Set up job` task with this kind of log :
+
+```text
+Download action repository 'rlespinasse/github-slug-action@master'
+##[error]An action could not be found at the URI 'https://api.github.com/repos/rlespinasse/github-slug-action/tarball/master'
+```
+
+> The master branch doesn't exists anymore.
+>
+> The master branch EOL has been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][issue-15])
+
+Please, use the current branch `v3.x` or a version tag (see [releases pages][releases]) in order to fix your workflow.
+
+## Thanks for talking about us
+
+- [Mettre en place une CI/CD Angular avec GitHub Actions & Netlify][article-1] (in french :fr:)
+- [Github Actions : enfin des pipelines accessibles aux développeurs][talk-1] (in french :fr:)
+- [Action spotlight by Michael Heap][article-2]
+- The next one is you. _Don't hesitate to add youself to this list._
+
+[actions]: https://github.com/rlespinasse/github-slug-action/actions
+[license]: https://github.com/rlespinasse/github-slug-action/blob/v3.x/LICENSE
+[examples]: https://github.com/rlespinasse/github-slug-action/tree/v3.x/examples
+[custom-variable]: https://github.com/rlespinasse/github-slug-action/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+[releases]: https://github.com/rlespinasse/github-slug-action/releases
+[issue-15]: https://github.com/rlespinasse/github-slug-action/issues/15
+[issue-104]: https://github.com/rlespinasse/github-slug-action/issues/104
+
+[default-environment-variables]: https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
+[dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+[webhooks-and-events]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
+[naming-conventions]: https://docs.github.com/en/actions/reference/environment-variables#naming-conventions-for-environment-variables
+
+[article-1]: https://esensconsulting.medium.com/mettre-en-place-une-ci-cd-angular-avec-github-actions-netlify-ca0b59b99ed8
+[article-2]: https://michaelheap.com/github-slug-action/
+[talk-1]: https://www.youtube.com/watch?v=RHnTJBwcE98

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.

__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')
+})

__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')
+})

__tests__/slug.test.ts

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

__tests__/slugref.test.ts

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

__tests__/slugurl.test.ts

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

__tests__/slugurlref.test.ts

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

action.yml

@@ -1,9 +1,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: 'node20'
+  main: 'dist/index.js'
 branding:
-  icon: 'crop'  
-  color: 'orange'
+  icon: 'minimize'
+  color: 'blue'

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

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              |

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                                 |

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

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

entrypoint.sh

@@ -1,12 +0,0 @@
-#!/bin/sh -l
-
-slug_ref() {
-    echo $1 \
-         | tr A-Z a-z \
-         | sed -r 's#refs/.*/##;s/[~\^]+//g;s/[^a-zA-Z0-9]+/-/g;s/^-+\|-+$//g' \
-         | 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)

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 }}"

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 }}"

examples/url-use.yml

@@ -0,0 +1,20 @@
+name: URL use
+
+on: push
+
+jobs:
+  as_subdomain:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: rlespinasse/github-slug-action@v3.x
+      - run: |
+          ./deploy-application.sh --url "https://${{ env.GITHUB_REF_SLUG_URL }}.staging.app.example.com"
+
+  as_resource_path:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: rlespinasse/github-slug-action@v3.x
+      - run: |
+          ./deploy-application.sh --url "https://staging.app.example.com/${{ env.GITHUB_REF_SLUG_URL }}"

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"

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
+}

package.json

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

src/main.ts

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

src/partial.ts

@@ -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}`), '')
+}

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)
+}

src/slug.ts

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

tsconfig.json

@@ -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"]
+}