# action-github-slug **Repository Path**: mirrors_getsentry/action-github-slug ## Basic Information - **Project Name**: action-github-slug - **Description**: GitHub Action to expose slug value of GitHub environment variables inside your GitHub workflow - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: v3.x - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-12-16 - **Last Updated**: 2026-03-01 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # GitHub Slug action [![Actions Status][1]][2] ![GitHub Super-Linter][13] [![Public workflows that use this action.][8]][9] [![Licence][11]][12] This GitHub Action will expose the slug value of all [GitHub environment variables][10] inside your GitHub workflow. `Slug` 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 Others `Slug`-ish commands are available: - `Slug URL` a variable will be like the `slug` variable but the `.` character will also be replaced by `-` - `Short SHA` a variable will limit the string size to 8 characters ## Exposed GitHub environment variables ```yaml - name: Inject slug/short variables uses: rlespinasse/github-slug-action@v3.x - name: Print slug/short variables run: | echo "Slug variables" echo " ref : ${{ env.GITHUB_REF_SLUG }}" echo " head ref : ${{ env.GITHUB_HEAD_REF_SLUG }}" echo " base ref : ${{ env.GITHUB_BASE_REF_SLUG }}" echo " event ref : ${{ env.GITHUB_EVENT_REF_SLUG }}" echo " repository : ${{ env.GITHUB_REPOSITORY_SLUG }}" echo "Slug URL variables" echo " ref : ${{ env.GITHUB_REF_SLUG_URL }}" echo " head ref : ${{ env.GITHUB_HEAD_REF_SLUG_URL }}" echo " base ref : ${{ env.GITHUB_BASE_REF_SLUG_URL }}" echo " event ref : ${{ env.GITHUB_EVENT_REF_SLUG_URL }}" echo " repository : ${{ env.GITHUB_REPOSITORY_SLUG_URL }}" echo "Short SHA variables" echo " sha : ${{ env.GITHUB_SHA_SHORT }}" ``` Read [default environment variables][3] page for more information. **TIP:** Use [Dependabot][14] to maintain your `github-slug-action` version updated in your GitHub workflows. ### GITHUB_REF_SLUG / GITHUB_REF_SLUG_URL 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 | GITHUB_REF_SLUG_URL | | ------------------------------ | ------------------- | ------------------- | | refs/heads/master | master | master | | refs/heads/feat/new_feature | feat-new-feature | feat-new-feature | | refs/tags/v1.0.0 | v1.0.0 | v1-0-0 | | refs/tags/product@1.0.0-rc.2 | product-1.0.0-rc.2 | product-1-0-0-rc-2 | | refs/heads/New_Awesome_Product | new-awesome-product | new-awesome-product | > **NOTE :** > GITHUB_REF_SLUG_URL is design to be used as subdomain in an URL. _Additional variables (only set for forked repositories) :_ - `GITHUB_HEAD_REF_SLUG`/`GITHUB_HEAD_REF_SLUG_URL`, The branch of the head repository **GITHUB_HEAD_REF** - `GITHUB_BASE_REF_SLUG`/`GITHUB_BASE_REF_SLUG_URL`, The branch of the base repository **GITHUB_BASE_REF** _Additional variables (only set for [create][4], and [delete][5] webhook events with `ref` data) :_ - `GITHUB_EVENT_REF_SLUG`/`GITHUB_EVENT_REF_SLUG_URL`, The git reference resource associated to the webhook. ### GITHUB_REPOSITORY_SLUG / GITHUB_REPOSITORY_SLUG_URL Slug the environment variable **GITHUB_REPOSITORY** The owner and repository name. | GITHUB_REPOSITORY | GITHUB_REPOSITORY_SLUG | GITHUB_REPOSITORY_SLUG_URL | | -------------------------- | -------------------------- | -------------------------- | | octocat/Hello-World | octocat-hello-world | octocat-hello-world | | rlespinasse/Hello-World.go | rlespinasse-hello-world.go | rlespinasse-hello-world-go | > **NOTE :** > GITHUB_REPOSITORY_SLUG_URL is design to be used as subdomain in an URL. ### GITHUB_SHA_SHORT Short the environment variable **GITHUB_SHA** The commit SHA that triggered the workflow | GITHUB_SHA | GITHUB_SHA_SHORT | | ---------------------------------------- | ---------------- | | ffac537e6cbbf934b08745a378932722df287a53 | ffac537e | ### Use slug variable in an URL In an URL, use `_SLUG_URL` instead of **\_SLUG** as subdomain to be compliant. > **NOTE :** > \_SLUG can be used in an URL only as part of the \_resource path*. ```yaml - name: Inject slug/short variables uses: rlespinasse/github-slug-action@v3.x - name: Deploy dummy application using slug in the 'subdomain' part run: | ./deploy-application.sh --url "https://${{ env._SLUG_URL }}.staging.app.mycompany.com" - name: Deploy dummy application using slug in the 'resource path' part run: | ./deploy-application.sh --url "https://staging.app.mycompany.com/${{ env._SLUG }}" ``` ## Contribute Follow [Developers guide](DEVELOPERS.md) ## Troubleshooting ### Missing master branch 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' ``` Please, use the current branch `v3.x` or a version tag (see [releases pages][6]) in order to fix your workflow. > The master branch don't exists anymore. > > The master branch EOL have been set to **2020-10-25** after a 6-month deprecation period (more information on the [EOL issue][7]) [1]: https://github.com/rlespinasse/github-slug-action/workflows/Build/badge.svg [2]: https://github.com/rlespinasse/github-slug-action/actions [3]: https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables [4]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#create [5]: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#delete [6]: https://github.com/rlespinasse/github-slug-action/releases [7]: https://github.com/rlespinasse/github-slug-action/issues/15 [8]: https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Drlespinasse%2Fgithub-slug-action%26badge%3Dtrue [9]: https://github.com/search?o=desc&q=rlespinasse/github-slug-action+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code [10]: https://docs.github.com/en/free-pro-team@latest/actions/reference/environment-variables#default-environment-variables [11]: https://img.shields.io/github/license/rlespinasse/github-slug-action [12]: https://github.com/rlespinasse/github-slug-action/blob/v3.x/LICENSE [13]: https://github.com/rlespinasse/github-slug-action/workflows/Lint/badge.svg [14]: https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot