From 68b422ce7d14d4330d2cb9b159bf4c8ea9a648b5 Mon Sep 17 00:00:00 2001 From: Franz Diebold Date: Thu, 3 Dec 2020 07:23:45 +0100 Subject: [PATCH] Improve documentation of CI_REF_* family. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3fc221c..1e5b9af 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,12 @@ A [GitHub Action](https://github.com/features/actions) to expose useful environm | `CI_REPOSITORY_NAME` | The name of the repository. | `github-env-vars-action` | | `CI_REPOSITORY_NAME_SLUG` | The slug of the name of the repository. | `github-env-vars-action` | | `CI_REPOSITORY` | The owner and repository name. Copy of `GITHUB_REPOSITORY` - for reasons of completeness. | `FranzDiebold/github-env-vars-action` | -| `CI_REF_SLUG` | The slug of the branch or tag *ref* that triggered the workflow (i.e. slug of `refs/heads/feat/feature-branch-1`).
If neither a branch or tag is available for the event type, the variable will not exist. | `refs-heads-feat-feature-branch-1` | -| `CI_ACTION_REF_NAME` | The branch or tag *name* that triggered the workflow. For pull requests it is the *head* branch name. | `feat/feature-branch-1` | -| `CI_ACTION_REF_NAME_SLUG` | The slug of the branch or tag *name* that triggered the workflow. For pull requests it is the slug of the *head* branch name. | `feat-feature-branch-1` | -| `CI_REF_NAME` | The branch or tag *name* that triggered the workflow.
If neither a branch or tag is available for the event type, the variable will not exist. | `feat/feature-branch-1` | -| `CI_REF_NAME_SLUG` | The slug of the branch or tag *name* that triggered the workflow.
If neither a branch or tag is available for the event type, the variable will not exist. | `feat-feature-branch-1` | -| `CI_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. Copy of `GITHUB_REF` - for reasons of completeness. | `refs/heads/feat/feature-branch-1` | +| `CI_REF_SLUG` | The slug of the branch, tag or PR number *ref* that triggered the workflow (i.e. slug of `refs/heads/feat/feature-branch-1`).
If neither a branch, tag or PR number is available for the event type, the variable will not exist. | `refs-heads-feat-feature-branch-1` or
`refs-tags-v1-3-7` or
`refs-pull-42-merge` | +| `CI_ACTION_REF_NAME` | The branch or tag *name* that triggered the workflow. For pull requests it is the *head* branch name. | `feat/feature-branch-1` or
`v1.3.7` | +| `CI_ACTION_REF_NAME_SLUG` | The slug of the branch or tag *name* that triggered the workflow. For pull requests it is the slug of the *head* branch name. | `feat-feature-branch-1` or
`v1-3-7` | +| `CI_REF_NAME` | The branch *name*, tag *name* or PR number that triggered the workflow.
If neither a branch, tag or PR number is available for the event type, the variable will not exist. | `feat/feature-branch-1` or
`v1.3.7` or
`42/merge` | +| `CI_REF_NAME_SLUG` | The slug of the branch *name*, tag *name* or PR number that triggered the workflow.
If neither a branch, tag or PR number is available for the event type, the variable will not exist. | `feat-feature-branch-1` or
`v1-3-7` or
`42-merge` | +| `CI_REF` | The branch, tag or PR number *ref* that triggered the workflow.
If neither a branch, tag or PR number is available for the event type, the variable will not exist. Copy of `GITHUB_REF` - for reasons of completeness. | `refs/heads/feat/feature-branch-1` or
`refs/tags/v1.3.7` or
`refs/pull/42/merge` | | `CI_HEAD_REF_SLUG` | The slug of the head branch *name*.
Only set for event type *pull request* or forked repositories. | `feat-feature-branch-1` | | `CI_HEAD_REF` | Only set for forked repositories / pull request. The branch of the head repository / the head branch name. Copy of `GITHUB_HEAD_REF` - for reasons of completeness. | `feat/feature-branch-1` | | `CI_BASE_REF_SLUG` | The slug of the base branch *name*.
Only set for event type *pull request* or forked repositories. | `main` |