https://github.com/superbrothers/close-pull-request

A GitHub Action to automatically close pull requests.
https://github.com/superbrothers/close-pull-request

actions github-actions

Last synced: 1 day ago
JSON representation

A GitHub Action to automatically close pull requests.

• Host: GitHub
• URL: https://github.com/superbrothers/close-pull-request
• Owner: superbrothers
• License: mit
• Created: 2019-02-28T11:40:11.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T11:00:26.000Z (about 1 year ago)
• Last Synced: 2024-10-14T14:06:22.726Z (2 months ago)
• Topics: actions, github-actions
• Language: JavaScript
• Homepage:
• Size: 1.4 MB
• Stars: 45
• Watchers: 4
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# :no_entry_sign: 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](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#pull_request_target) for more details about the `pull_request_target` event.

```yaml

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."

```

## Inputs

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

## LICENSE

This software is released under the MIT License.