https://github.com/actionsdesk/close-issue-action

https://github.com/actionsdesk/close-issue-action

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/actionsdesk/close-issue-action
• Owner: ActionsDesk
• License: mit
• Created: 2020-01-14T16:56:18.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T05:13:20.000Z (almost 2 years ago)
• Last Synced: 2024-10-19T11:41:29.174Z (29 days ago)
• Language: TypeScript
• Size: 1.17 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# close-issue-action

A simple action that closes the issue.  Intended for use with the issue events.

## Usage

```

on:

  issues:

    types: [ opened ]

jobs:

  SampleWorkflow:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v1

      - name: Close Issue

        uses: ActionsDesk/close-issue-action@release/v1

        env:

          GITHUB_TOKEN: ${{ secrets.ADMIN_TOKEN }}

```

## Environment Variables  

* `GITHUB_TOKEN`: Personal Access Token (PAT) of a member of the organization that has privileges to close issues

### Why is this needed  

The action needs to create an Octokit context that has permissions to update issues (in this case simply updating the state)

## Contributing

See anything you would like to help with?  Please submit PR's, and ensure you write tests covering your new functionality.  (CI and a more complete test suite to be written :smile: )

## License

All code and documentation in this repository are licensed under the [MIT License](LICENSE)