forked from thollander/actions-comment-pull-request
-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme and package description
- Loading branch information
Showing
3 changed files
with
24 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,28 @@ | ||
# Comment Pull Request - GitHub Actions | ||
# Comment on Issues - GitHub Actions | ||
|
||
A GitHub action that comments with a given message the pull request linked to the pushed branch. | ||
A GitHub action that comments on issues with a given message. | ||
You can even put dynamic data thanks to [Contexts and expression syntax](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions). | ||
|
||
## Usage | ||
|
||
``` | ||
on: pull_request | ||
name: issue-checklist | ||
on: | ||
issues: | ||
types: [opened] | ||
jobs: | ||
example_comment_pr: | ||
comment: | ||
runs-on: ubuntu-latest | ||
name: An example job to comment a PR | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v1 | ||
- name: Comment PR | ||
uses: thollander/actions-comment-pull-request@master | ||
with: | ||
message: 'Example of message !' | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
- uses: ben-z/[email protected] | ||
with: | ||
message: "Gentle reminder:\n* Did you go through all of the troubleshooting steps outlined in README.md?" | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
``` | ||
|
||
See examples in [opened PR](https://github.com/thollander/actions-comment-pull-request/pulls) ! | ||
|
||
:information_source: : Make sure to listen to `pull_request` events. | ||
Otherwise, it will not be able to comment the PR and you'll have an error. | ||
|
||
## Contributing | ||
|
||
### Build | ||
|
@@ -37,4 +32,4 @@ It is handled by Typescript compiler. | |
|
||
```sh | ||
$ npm run build | ||
``` | ||
``` |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters