This GitHub Action will expose the slug/short values of some GitHub environment variables inside your GitHub workflow.

• GitHub Slug action
  • Table of Contents
  • Overview
  • Use this action
  • Available Environment variables
    • Enhanced variables
    • Partial variables
    • Slug variables
    • Slug URL variables
    • Short variables
  • Contribute
  • Troubleshooting
    • One of the environment variables doesn't work as intended
    • An action could not be found at the URI
  • Thanks for talking about us

SLUG on a variable will

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

Additional enhanced environment variables can be compute to help you around GitHub environment variables.

Add this in your workflow

- name: Inject slug/short variables
  uses: rlespinasse/[email protected]

Check for more examples (OS usage, URL use, ...)

Tip: Use Dependabot to maintain your github-slug-action version updated in your GitHub workflows.

Note: If you don't find what you search for, read more about available GitHub variables, and propose a new custom variable.

• GITHUB_REF_NAME will contains the reference name (branch or tag)
  • based on GITHUB_HEAD_REF in a pull-request* event context,
  • based on GITHUB_REF in others event context.

NOTE: All enhanced variables are available in all slug formats.

NOTE: _CS suffix available

NOTE: _CS suffix available

Follow Developers guide

Note: GitHub reserves the GITHUB_ environment variable prefix for internal use by GitHub. Setting an environment variable or secret with the GITHUB_ prefix will result in an error.

Currently, a GitHub workflow setting a GITHUB_ variable will not cause an error, it will just fail silently. And if a custom GITHUB_ variable is in conflict with an official GITHUB_ variable, the offical GITHUB_ variable will override custom one.

name: Test
on: push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - run: echo ${GITHUB_REF}
      # print "refs/heads/v3.x"
      - run: echo "GITHUB_REF=one_value" >> "$GITHUB_ENV"
      - run: echo ${GITHUB_REF}
      # print "refs/heads/v3.x"
      - run: echo "GITHUB_REF_SLUG=another_value" >> "$GITHUB_ENV"
      - run: echo ${GITHUB_REF_SLUG}
      # print "another_value"

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

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)

Please, use the current branch v3.x or a version tag (see releases pages) in order to fix your workflow.

• Mettre en place une CI/CD Angular avec GitHub Actions & Netlify (in french 🇫🇷)
• Github Actions : enfin des pipelines accessibles aux développeurs (in french 🇫🇷)
• Action spotlight by Michael Heap
• The next one is you. Don't hesitate to add youself to this list.