fetch-repo-branches

Fetch Repo Branches

A GitHub Action for fetching branches via GitHub API.

Example usage:

name: Example Workflow for Fetch Repo Branches
on: push
jobs:
  fetch-latest-branches:
    runs-on: ubuntu-latest

    outputs:
      latest-branches: ${{ steps.get-latest-branches.outputs.repo-branches }}

    steps:
      - uses: actions/checkout@v3

      - name: "Fetch ${{ inputs.package_name }} Protected Branches Metadata"
        uses: dbt-labs/actions/fetch-repo-branches@main
        id: get-latest-branches
        with:
          repo_name: "dbt-core"
          organization: "dbt-labs"
          pat: ${{ secrets.GITHUB_TOKEN }}
          fetch_protected_branches_only: true
          regex: "^1.[0-9]+.latest$"
          perform_match_method: "match"
          retries: 3

      - name: "Display Latest Branches"
        run: |
          echo repo latest branches: ${{ steps.get-latest-branches.outputs.repo-branches }}

    dynamic-matrix:
      runs-on: ubuntu-latest
      needs: fetch-latest-branches

      strategy:
        fail-fast: false
        matrix:
          branch: ${{ fromJSON(needs.fetch-latest-branches.outputs.latest-branches) }}

      steps:
        - name: "Display Branch Name"
          run: |
            echo branch name: ${{ matrix.branch }}

Inputs

Property	Required	Default	Description
repo_name	yes	-	Repo name
organization	yes	-	Organization that owns repo
pat	yes	-	PAT for fetch request
fetch_protected_branches_only	no	false	Adjust request to fetch only protected branches
regex	no	empty string	Filter container tags
perform_match_method	no	match	Select which method use to filter tags (search/match/findall)
retries	no	3	Retries for fetch request

Outputs

Property	Example	Description
repo-branches	['1.0.latest', '1.1.latest', '1.2.latest', '1.3.latest', '1.4.latest']	List of branches matching request