actions/marocchino-sticky-pull-request-comment
2
0
Fork 0
mirror of https://github.com/marocchino/sticky-pull-request-comment.git synced 2025-12-12 19:51:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update description

Browse source
This commit is contained in:
marocchino 2021-02-25 16:39:39 +09:00
parent fa221d0b75
commit 78e3496c31
No known key found for this signature in database
GPG key ID: AFF521DBDB122570
2 changed files with 35 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
README.md
View file

@ -3,7 +3,7 @@
Create comment on pull request, if exists update that comment. Create comment on pull request, if exists update that comment.
This library runs with GitHub Actions. If you feel that the example grammar below is not friendly enough, we recommend reading [this page](https://docs.github.com/en/actions) first. This library runs with GitHub Actions. If you feel that the example grammar below is not friendly enough, we recommend reading [this page](https://docs.github.com/en/actions) first.
## Usage: ## Usage
### Basic ### Basic
@ -120,57 +120,48 @@ with:
delete: true delete: true
``` ```
## Inputs
## Development ### `header`
Install the dependencies **Optional** Header to determine if the comment is to be updated, not shown on screen. It can be used when you want to add multiple comments independently at the same time.
```bash ### `append`
$ npm install
```
Build the typescript **Optional** Indicate if new comment messages should be appended to previous comment message. Only `true` is allowed. Just skip this item when you don't need it.
```bash ### `recreate`
$ npm run build
```
Run the tests :heavy_check_mark: **Optional** Indicate if previous comment should be removed before creating a new comment. Only `true` is allowed. Just skip this item when you don't need it.
```bash ### `delete`
$ npm test
PASS ./index.test.js **Optional** delete the previously created comment. Only `true` is allowed. Just skip this item when you don't need it.
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
... ### `message`
```
## Publish to a distribution branch **Optional** comment message
Actions are run from GitHub repos. We will create a releases branch and only checkin production modules (core in this case). ### `path`
Comment out node_modules in .gitignore and create a releases/v1 branch **Optional** path to file containing comment message
```bash ### `number`
# comment out in distribution branches
# node_modules/
```
```bash **Optional** pull request number for push event
$ git checkout -b releases/v1
$ git commit -a -m "prod dependencies"
```
```bash ### `repo`
$ npm prune --production
$ git add node_modules
$ git commit -a -m "prod dependencies"
$ git push origin releases/v1
```
Your action is now published! :rocket: **Optional** other repo url limited use on github enterprise. If not set, the current repo is used by default. Note that When you trying changing a repo, be aware that GITHUB_TOKEN should also use that repo's.
See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) ### `GITHUB_TOKEN`
**Required** set secrets.GITHUB_TOKEN here
## Outputs
no outputs
## Any problem?
Feel free to report issues. 😃

12
action.yml
View file

@ -3,13 +3,16 @@ description: "Create comment on pull request, if exists update that comment."
author: "marocchino" author: "marocchino"
inputs: inputs:
header: header:
description: "Header to determine if the comment is to be updated, not shown on screen" description: "Header to determine if the comment is to be updated, not shown on screen. It can be used when you want to add multiple comments independently at the same time."
required: false required: false
append: append:
description: "Indicate if new comment messages should be appended to previous comment message" description: "Indicate if new comment messages should be appended to previous comment message. Only `true` is allowed. Just skip this item when you don't need it."
required: false required: false
recreate: recreate:
description: "Indicate if previous comment should be removed before creating a new comment" description: "Indicate if previous comment should be removed before creating a new comment. Only `true` is allowed. Just skip this item when you don't need it."
required: false
delete:
description: "delete the previously created comment. Only `true` is allowed. Just skip this item when you don't need it."
required: false required: false
message: message:
description: "comment message" description: "comment message"
@ -20,9 +23,6 @@ inputs:
number: number:
description: "pull request number for push event" description: "pull request number for push event"
required: false required: false
delete:
description: "delete the previously created comment"
required: false
repo: repo:
description: "other repo url limited use on github enterprise. If not set, the current repo is used by default. Note that When you trying changing a repo, be aware that GITHUB_TOKEN should also use that repo's." description: "other repo url limited use on github enterprise. If not set, the current repo is used by default. Note that When you trying changing a repo, be aware that GITHUB_TOKEN should also use that repo's."
required: false required: false