mirror of
https://github.com/FranzDiebold/github-env-vars-action.git
synced 2024-11-09 10:33:36 -05:00
Improve documentation.
This commit is contained in:
parent
c595cd5fcb
commit
45e833f67e
1 changed files with 12 additions and 12 deletions
24
README.md
24
README.md
|
@ -4,24 +4,24 @@ A [GitHub Action](https://github.com/features/actions) to expose useful environm
|
|||
|
||||
### Environment Variables exposed by **this Action**
|
||||
|
||||
| Environment Variable Name | Example value |
|
||||
|---------------------------|---------------------------|
|
||||
| `GITHUB_REPOSITORY_OWNER` | `FranzDiebold` |
|
||||
| `GITHUB_REPOSITORY_NAME` | `github-env-vars-action` |
|
||||
| `GITHUB_REF_NAME` | `feature-branch-1` |
|
||||
| `GITHUB_SHA_SHORT` | `ffac537e` |
|
||||
| Environment Variable Name | Description | Example value |
|
||||
|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
|
||||
| `GITHUB_REPOSITORY_OWNER` | The owner of the repository. | `FranzDiebold` |
|
||||
| `GITHUB_REPOSITORY_NAME` | The name of the repository. | `github-env-vars-action` |
|
||||
| `GITHUB_REF_NAME` | The branch name that triggered the workflow. If neither a branch or tag is available for the event type, the variable will not exist. | `feature-branch-1` |
|
||||
| `GITHUB_SHA_SHORT` | The shortened commit SHA (8 characters) that triggered the workflow. | `ffac537e` |
|
||||
|
||||
|
||||
### Default Environment Variables exposed by GitHub
|
||||
|
||||
For a full list of default environment variables exposed by GitHub see [https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables).
|
||||
|
||||
| Environment Variable Name | Example value |
|
||||
|---------------------------|-----------------------------------------------|
|
||||
| `GITHUB_ACTOR` | `octocat` |
|
||||
| `GITHUB_REPOSITORY` | `FranzDiebold/github-env-vars-action` |
|
||||
| `GITHUB_SHA` | `ffac537e6cbbf934b08745a378932722df287a53` |
|
||||
| `GITHUB_REF` | `refs/heads/feature-branch-1` |
|
||||
| Environment Variable Name | Description | Example value |
|
||||
|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|
|
||||
| `GITHUB_ACTOR` | The name of the person or app that initiated the workflow. | `octocat` |
|
||||
| `GITHUB_REPOSITORY` | The owner and repository name. | `FranzDiebold/github-env-vars-action` |
|
||||
| `GITHUB_SHA` | The commit SHA that triggered the workflow. | `ffac537e6cbbf934b08745a378932722df287a53` |
|
||||
| `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. | `refs/heads/feature-branch-1` |
|
||||
|
||||
## Example usage
|
||||
|
||||
|
|
Loading…
Reference in a new issue