pulls-merge.md

Merge pull request

A composite action for merging a pull request. This requires pull-requests: write permissions in order to work correctly.

Inputs

Name	Description	Default
commit-message	The commit message to use. Defaults to the pull-request message if not specified.	""
commit-title	The commit title to use. Defaults to the pull-request title if not specified.	""
github-token	The default token to use for this Git operation. If unspecified, this will default to github.token.	"${{ github.token }}"
merge-method	The merge method to use. Can be one of: merge, squash, rebase.	""
owner	The repository owner. If unspecified, this will default to the owner of the current repository.	""
pull-number	The pull request number to comment on	"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"
sha	SHA that pull request head must match to allow merge.	""

Outputs

pulls/merge does not have any outputs at this time

Example

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

run:
  example-job:
    # ... 
    steps:
      # ... 
      - name: Merge pull request
        uses: bitwizeshift/actions-github/pulls/merge@v1
        with:
          # Optional inputs
          commit-message: COMMIT_MESSAGE
          commit-title: COMMIT_TITLE
          github-token: GITHUB_TOKEN
          merge-method: MERGE_METHOD
          owner: OWNER
          pull-number: PULL_NUMBER
          repo: REPO
          retries: RETRIES
          retry-exempt-status-codes: RETRY_EXEMPT_STATUS_CODES
          sha: SHA