https://github.com/smartlyio/comment-to-pr-action
Comment to a PR with a message. By default, comments if message is not already present.
https://github.com/smartlyio/comment-to-pr-action
github-action javascript-action
Last synced: 9 months ago
JSON representation
Comment to a PR with a message. By default, comments if message is not already present.
- Host: GitHub
- URL: https://github.com/smartlyio/comment-to-pr-action
- Owner: smartlyio
- License: mit
- Created: 2019-12-16T09:15:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-04T07:48:11.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T06:24:34.670Z (over 1 year ago)
- Topics: github-action, javascript-action
- Language: JavaScript
- Homepage:
- Size: 979 KB
- Stars: 0
- Watchers: 89
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Comment to PR action
This action will add a comment to a PR. If `exclusive` flag is not explicitly set to false, the comment will only be created if there is not already an identical comment present.
## Inputs
### `comment`
**Required** The text of the comment.
### `GITHUB_TOKEN`
**Required** The token to access the repo, same one as is available in the action.
### `exclusive`
**Optional** Do not comment if there is already an identical comment. Default true.
## Example usage
```yaml
uses: smartlyio/comment-to-pr-action@v3
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
comment: 'The kittens have decreed that this PR is acceptable!'
```
## Development
### Development scripts
- Run typescript: `npm run compile`
- Run test: `npm run test`
- Run linters: `npm run lint`
Run all the above: `npm run all`
### Release new version
Follow these steps to release a new version
1. Create release branch: `git checkout -b v{next-version}`
2. Compile your `index.js` file. `ncc build index.js`
3. Push the required changes to git:
`git add dist/index.js`
`git commit -m "New version with great changes"`
`git push`