Action used to create branches and optional associated protection.

• Create the specified branch if not existing.
• If requested, permission can be added on some branches. Theses permission can be defined in JSON or YAML format and can be describe in a local/remote file, or directly in the input.

The following example works on the GitHub repository the_owner/the_repo_name. It defined 3 branches develop, feature and toto that will be added if not already existing:

• develop and feature branch are created from the main branch.
• toto branch is created from the specified anotherBranch branch.
• permission defined for the feature branch will be applied.

The definition is wrote directly in the action inputs.

- uses: fletort/branch-protection-action@v1
  with:
    repository: the_owner/the_repo_name
    token: ${{ secrets.token }}
    branches: |
      develop:
      feature:
        permission:
          required_status_checks:
          enforce_admins: true
          required_pull_request_reviews: {
            "required_approving_review_count": 0
          }
          restrictions:  
      toto:
        baseBranch: anotherBranch

Note: to invoke the action you can also pin to a specific release version in the format @v1.x.x or @v1.x.

The token must have the following permissions:

• 'Repository Contents / Write': to be able to create new branch on the repository.
• 'Repository Administration / Write': to be able to update permission on branches

Branches definition can be wrote in JSON or YAML format. It is a list of branch (key is the name of the branch) that containes following optional information :

• JSON

{
  "branch_name" : {
    "baseBranch": "optionalBaseBranch",
    "permission": {...}
  },
  "another_branch_name": {
    ...
  }
}

• YAML

branch_name:
  baseBranch: optionalBaseBranch
  permission:
    required_status_checks:
    enforce_admins: true
    ...
another_branch_name:
  ...

The input can be directly the data as show in the exemple upper, a local file, or a remote file:

• local file: The file must be inside the repository calling the action and can be a YAML or json file.

- uses: fletort/branch-protection-action@v1
  with:
    repository: the_owner/the_repo_name
    token: ${{ secrets.token }}
    branches: ./my_local_definition.json

• remote file: The file must available on a public web link.

For example we can use the file available on anoter repository:

- uses: fletort/branch-protection-action@v1
  with:
    repository: the_owner/the_repo_name
    token: ${{ secrets.token }}
    branches: https://raw.githubusercontent.com/owner/anoter-repo/refs/heads/main/branch-perm.yml

All unit/functional test executed on each branch/PR are listed/described on this testspace space.

Unit Test Coverage Information is available on coverage