Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
slash

GitHub Action

Close Pull Request

v3.0.0

Close Pull Request

slash

Close Pull Request

A GitHub action to automatically close a pull request

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Close Pull Request

              
  uses: superbrothers/close-pull-request@v3.0.0
Learn more about this action in superbrothers/close-pull-request

Choose a version

🚫 Close Pull Request

A GitHub action to automatically close a pull request.

Usage

This Action subscribes to pull_request_target events. When receiving a pull_request_target event, this action closes the pull request triggered by the event immediately.

See Events that trigger workflows for more details about the pull_request_target event.

name: Close Pull Request

on:
  pull_request_target:
    types: [opened]

jobs:
  run:
    runs-on: ubuntu-latest
    steps:
    - uses: superbrothers/close-pull-request@v3
      with:
        # Optional. Post a issue comment just before closing a pull request.
        comment: "We do not accept PRs. If you have any questions, please feel free to contact us."
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Inputs

  • comment - Optional. Post an issue comment just before closing a pull request.

LICENSE

This software is released under the MIT License.