Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meilcli/hidable-comment-action
Create, update or delete comment by action argument
https://github.com/meilcli/hidable-comment-action
actions github-actions
Last synced: 20 days ago
JSON representation
Create, update or delete comment by action argument
- Host: GitHub
- URL: https://github.com/meilcli/hidable-comment-action
- Owner: MeilCli
- License: mit
- Created: 2021-02-28T10:48:41.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T09:03:48.000Z (8 months ago)
- Last Synced: 2024-05-01T12:35:43.519Z (8 months ago)
- Topics: actions, github-actions
- Language: TypeScript
- Homepage: https://github.com/MeilCli/actions
- Size: 12.5 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# hidable-comment-action
[](https://github.com/MeilCli/hidable-comment-action/actions/workflows/ci-master.yml)
Create, update or delete comment by action argument
## Example
### Check issue title
```yml
name: 'Check-Issue-Title'
on:
issues:
types: [opened, edited, reopened]
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: MeilCli/regex-match@v2
id: regex
with:
regex_pattern: 'test: .*'
regex_option: 'g'
search_string: ${{ github.event.issue.title }}
- uses: MeilCli/hidable-comment-action@v2
with:
number: ${{ github.event.issue.number }}
show: ${{ steps.regex.outputs.matched == 'false' }}
id: 'title-lint'
body: |
title lint example body
- test1
- test2
- test3
```
You can also pin to a [specific release](https://github.com/MeilCli/hidable-comment-action/releases) version in the format @v2.x.x
### Check Pull Request title
```yml
name: 'Check-Pull-Request-Title'
on:
pull_request:
types: [opened, edited, reopened]
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: MeilCli/regex-match@v2
id: regex
with:
regex_pattern: 'test: .*'
regex_option: 'g'
search_string: ${{ github.event.pull_request.title }}
- uses: MeilCli/hidable-comment-action@v2
with:
number: ${{ github.event.pull_request.number }}
show: ${{ steps.regex.outputs.matched == 'false' }}
id: 'title-lint'
body: |
title lint example body
- test1
- test2
- test3
```
## Input
- `github_token`
- required
- github token, using to read repository
- default: `${{ github.token }}`
- `repository`
- required
- executed repository name
- for example: MeilCli/hidable-comment-action
- default: `${{ github.repository }}`
- `number`
- required
- issue or pull request number
- `id`
- required
- Id for identify multiple hidable-comment-action in same issue or repository
- default: `hidable-comment`
- `show`
- required
- value: `true` or `false`
- if set the true, add or update comment. if set the false, delete comment
- `body`
- required
- comment body
## Contributes
[
](https://github.com/MeilCli/hidable-comment-action/graphs/contributors)
### Could you want to contribute?
see [Contributing.md](./.github/CONTRIBUTING.md)
## License
[
](LICENSE.txt)
### Using
- [actions/toolkit](https://github.com/actions/toolkit), published by [MIT License](https://github.com/actions/toolkit/blob/master/LICENSE.md)
- [apollo-client](https://github.com/apollographql/apollo-client), published by [MIT License](https://github.com/apollographql/apollo-client/blob/main/LICENSE)
- [cross-fetch](https://github.com/lquixada/cross-fetch), published by [MIT License](https://github.com/lquixada/cross-fetch/blob/main/LICENSE)
- [graphql](https://github.com/graphql/graphql-js), published by [MIT License](https://github.com/graphql/graphql-js/blob/main/LICENSE)