rlespinasse/github-slug-action
1
0
Fork 0
mirror of https://github.com/rlespinasse/github-slug-action.git synced 2026-06-11 17:13:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve overview section

Browse Source
This commit is contained in:
Romain Lespinasse
2021-04-02 16:14:40 +02:00
committed by GitHub
parent 016823880d
commit 8c0a3268b6
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -37,10 +37,14 @@ This GitHub Action will expose the slug/short values of [some GitHub environment
<summary>Others <b>Slug-ish</b> commands are available</summary> <summary>Others <b>Slug-ish</b> commands are available</summary>
<p> <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 `-`) - `SLUG_URL` on a variable to have a `slug` variable compliant to be used in an URL
- `SHORT` on a variable will limit the string size to 8 characters (useful for _sha_ value) - 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 - `<KEY>_PART` on a variable will give a part of a variable defined by a key
_ `<VAR>_CS` on others variables to keep the value case-sensitive - 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> </p>
</details> </details>