repos-add-collaborator.md

Add repository collaborator

A composite action that adds a collaborator to the repository. Requires the contents: write permission to work.

Inputs

Name	Description	Default
username (*)	The handle for the GitHub user account.	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.	""
permission	The permission to grant the collaborator. Only valid on organization-owned repositories. Accept the following permissions to be set: pull, triage, push, maintain, admin, and you can also specify a custom repository role name, if the owning organization has defined any.	""
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

repos/add-collaborator does not have any outputs at this time

Example

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

run:
  example-job:
    # ... 
    steps:
      # ... 
      - name: Add repository collaborator
        uses: bitwizeshift/actions-github/repos/add-collaborator@v1
        with:
          # Required inputs
          username: USERNAME

          # Optional inputs
          github-token: GITHUB_TOKEN
          owner: OWNER
          permission: PERMISSION
          repo: REPO
          retries: RETRIES
          retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES