mirror of
https://github.com/rlespinasse/github-slug-action.git
synced 2026-06-13 01:51:09 +00:00
30 lines
717 B
Markdown
30 lines
717 B
Markdown
# 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.
|
|
|
|
## Environement 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 |
|
|
|
|
## Example usage
|
|
|
|
```yaml
|
|
- uses: rlespinasse/github-slug-action@master
|
|
- name: Print slug variables
|
|
run: |
|
|
echo ${{ env.GITHUB_REF_SLUG }}
|
|
echo ${{ env.GITHUB_HEAD_REF_SLUG }}
|
|
echo ${{ env.GITHUB_BASE_REF_SLUG }}
|
|
```
|