stevenjdh/Branch Details
A GitHub action that exposes information about branches, tags, and related concepts to simplify automation activities.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| drop-tag-prefix | Removes the prefix of a tag. For example, dropping the v in v1.0.0 using v, or the more regex style of [vV], as the input. | no | — |
| export-variables | Indicates whether or not to set environment variables for each output exposed by this action for other steps in a job. Format is BD_XXX with all in uppercase. For example, triggering_ref becomes BD_TRIGGERING_REF. | no | false |
| github-token | Overrides the default GitHub token to authenticate API requests. | no | ${{ github.token }} |
Outputs
| name | description |
|---|---|
| triggering_ref | The fully-formed ref of the branch or tag that triggered the workflow run. |
| is_tag | Indicates whether or not triggering_ref is a tag. |
| is_semver | Indicates whether or not tag is using semantic versioning. Always false when is_tag is false. |
| tag | The tag that triggered the workflow run. Will be empty when is_tag is false. |
| current_branch_name | The current working branch regardless of event type. Usually same as base_branch_name, but for pull requests, it's same as head_branch_name. |
| is_default_branch | Indicates whether or not current_branch_name is the default branch. |
| default_branch_name | The default branch for the repository. |
| base_branch_name | The target branch of a commit, pull request, tag, or other event. |
| head_branch_name | The source branch of a pull request, otherwise, it will be empty. |
| is_pull_request | Indicates whether or not triggering_ref is a pull request. |
| pull_request_id | Id of the pull request. Will be empty when is_pull_request is false. |
| repo_owner_name | The username of the user who owns the repository. |
| repo_name | The repository name. |
| event_actor_name | The username of the user or app that initiated the workflow run or rerun. |
| is_event_actor_rerun | Indicates whether or not event_actor triggered the workflow rerun. May not always be the same actor for reruns, but uses original actor's privileges for it. Will always be false for first runs. |
| is_event_actor_owner | Indicates whether or not event_actor is the repo_owner. |