pulls-add-assignees.md

Add assignees to Pull Request

A composite action for adding assignees to github pull requests. This requires pull-requests: write permissions in order to work correctly.

Inputs

Name	Description	Default
assignees (*)	A list of assignees to add, separated by newlines.	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.	""
pull-number	The pull request number to update	"0"
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

pulls/add-assignees does not have any outputs at this time

Example

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

run:
  example-job:
    # ... 
    steps:
      # ... 
      - name: Add assignees to Pull Request
        uses: bitwizeshift/actions-github/pulls/add-assignees@v1
        with:
          # Required inputs
          assignees: ASSIGNEES

          # Optional inputs
          github-token: GITHUB_TOKEN
          owner: OWNER
          pull-number: PULL_NUMBER
          repo: REPO
          retries: RETRIES
          retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES