/github-slug-action

Action to slug and expose some github variables

Primary LanguageShellMIT LicenseMIT

GitHub Slug action

This action slug and expose some github variables.

Slug a variable will

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

Others Slug-ish commands are available:

  • Short SHA a variable will limit the string size to 8 caracters.

Environment Variables

GitHub environment variable Slug variable
GITHUB_REF GITHUB_REF_SLUG
GITHUB_HEAD_REF GITHUB_HEAD_REF_SLUG
GITHUB_BASE_REF GITHUB_BASE_REF_SLUG
GitHub environment variable Short variable
GITHUB_SHA GITHUB_SHA_SHORT

Example usage

- uses: rlespinasse/github-slug-action@master
- name: Print slug variables
  run: |
    echo ${{ env.GITHUB_REF_SLUG }}
    echo ${{ env.GITHUB_HEAD_REF_SLUG }}
    echo ${{ env.GITHUB_BASE_REF_SLUG }}
    echo ${{ env.GITHUB_SHA_SHORT }}