git-get-branch.md

Get branch

A composite action for getting a branch. This requires contents: read permissions in order to work correctly.

Inputs

Name	Description	Default
branch (*)	The name of the git branch to get.	N/A
github-token	The default token to use for this Git operation. If unspecified, this will default to github.token.	"${{ github.token }}"
owner	The repository owner. If unspecified, this will default to the owner of the current repository.	""
repo	The name of the repository. If unspecified, this will default to the current repository.	""
retries	The number of times to attempt to retry if this fails.	"0"
retry-exempt-status-codes	A list of error-codes that are exempt from being retried.	"400,401,403,404,422"

Note: (*) marks required inputs

Outputs

Name	Description
ref	The ref to the tag
sha	The SHA of the tag

Example

Here is a very basic example of how to use the git/get-branch composite action in a project (placeholders are used in place of real inputs):

run:
  example-job:
    # ... 
    steps:
      # ... 
      - name: Get branch
        id: git-get-branch # only necessary if using this action's output(s)
        uses: bitwizeshift/actions-github/git/get-branch@v1
        with:
          # Required inputs
          branch: BRANCH

          # Optional inputs
          github-token: GITHUB_TOKEN
          owner: OWNER
          repo: REPO
          retries: RETRIES
          retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
      # ... 
      - name: Uses "Get branch" Outputs
        uses: example-actions/use-git-get-branch@v3 # illustrative
        with:
          use-ref: ${{ steps.git-get-branch.outputs.ref }}
          use-sha: ${{ steps.git-get-branch.outputs.sha }}