https://github.com/logerfo/close-action

A GitHub Action that automatically closes issues fixed in pull requests that doesn't target the default branch.
https://github.com/logerfo/close-action

actions close

Last synced: 19 days ago
JSON representation

A GitHub Action that automatically closes issues fixed in pull requests that doesn't target the default branch.

• Host: GitHub
• URL: https://github.com/logerfo/close-action
• Owner: Logerfo
• License: mit
• Created: 2019-10-29T13:02:11.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-04T22:11:39.000Z (about 1 month ago)
• Last Synced: 2024-10-09T12:23:43.051Z (about 1 month ago)
• Topics: actions, close
• Language: JavaScript
• Homepage:
• Size: 146 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Dependencies Status](https://david-dm.org/logerfo/close-action/dev-status.svg)](https://david-dm.org/logerfo/close-action?type=dev)

# Close Action

This action will automatically close issues fixed in pull requests that doesn't target the default branch.  

Only works for same repository references.  

Keywords are documented [here](https://help.github.com/en/articles/closing-issues-using-keywords).

## Setting up

Create a file named `.github/workflows/close.yml`.

### Minimal Configuration

```yml

name: Close

on: 

  pull_request:

    types: [closed]

    

jobs:

  build:

    name: Close

    runs-on: ubuntu-16.04

    steps:

    - uses: Logerfo/[email protected]

      with:

        github-token: ${{ secrets.GITHUB_TOKEN }}

```

### Complete configuration

All values are default.

```yml

name: Close

on: 

  pull_request:

    types: [closed]

    

jobs:

  build:

    name: Close

    runs-on: ubuntu-16.04

    steps:

    - uses: Logerfo/[email protected]

      with:

        github-token: ${{ secrets.GITHUB_TOKEN }} # The `GITHUB_TOKEN` secret.

        comment: true # If `true`, will comment on the closing issue(s).

```

### Auto update

You can use (at your own risk) the `release` branch instead of the specific version tag.  

Never user `master`, since the distribution file does not exist in this branch and the action will always fail.

## Changelog

Click [here](CHANGELOG.md).

## Contributing

If you have suggestions for how close-label could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the [Contributing Guide](CONTRIBUTING.md).

## Donate



BTC: 1LoGErFoNzE1gCA5fzk6A82nV6iJdKssSZ