-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(action): Updated readme & removed unnecessary logging
- Loading branch information
1 parent
e35f83a
commit 7c90a39
Showing
4 changed files
with
108 additions
and
11 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 |
---|---|---|
|
@@ -2,18 +2,20 @@ | |
|
||
This actions toggle labels like "awaiting-reply" or "need-more-info" which indicates response is required for further action. This is useful if you want to filter out issue already responded to the issue author but the author isn't responded back. | ||
|
||
**Usecase:** | ||
Mostly in premium product or service customer support is top priority. In this scenario customer may create issue and sales team replies back withing their business days. This action really helps in filtering only those issues which requires sales teams response. Those issue which are already answered/responded will be marked via `awaiting-reply` or `need-more-info`. | ||
**Use case:** | ||
Mostly in premium product or service customer support is top priority. In this scenario customer may create issue and sales team replies back withing their business days. This action really helps in filtering only those issues which requires sales teams response. Those issue which are already answered/responded will be marked via "awaiting-reply" or "need-more-info". | ||
|
||
This is same of large open source community where an individual what to help people and want to check only those issues where no team member responded yet. | ||
|
||
> *This action is highly inspired by already existing action [pending-response](https://github.com/siegerts/pending-response) by [siegerts](https://github.com/siegerts)* | ||
## Inputs | ||
|
||
### `token`* | ||
### `token` | ||
|
||
GitHub personal token | ||
#### *Default: ${{ github.token }}* | ||
|
||
GitHub token | ||
|
||
### `label`* | ||
|
||
|
@@ -47,6 +49,98 @@ Ignore operation if commented by team members specified in `exclude-members`. Th | |
## Example Usage | ||
|
||
> NOTE: Do update action version `jd-0001/gh-action-toggle-awaiting-reply-label@{YOUR_DESIRED_VERSION}`. This will help you keep using this action if we introduce breaking changes. | ||
### Toggle specified label on each issue | ||
|
||
```yml | ||
on: | ||
issue_comment: | ||
types: [created] | ||
|
||
jobs: | ||
hello_world_job: | ||
runs-on: ubuntu-latest | ||
name: Job for toggling label | ||
steps: | ||
- name: Toggle label | ||
uses: jd-0001/[email protected] | ||
with: | ||
label: question | ||
``` | ||
### Remove specified label only if repo owner or member comment on issue (not collaborator) | ||
```yml | ||
on: | ||
issue_comment: | ||
types: [created] | ||
|
||
jobs: | ||
hello_world_job: | ||
runs-on: ubuntu-latest | ||
name: Job for toggling label | ||
steps: | ||
- name: Toggle label | ||
uses: jd-0001/[email protected] | ||
with: | ||
label: question | ||
member-association: OWNER, MEMBER | ||
``` | ||
### Ignore toggling label if specified label is present on issue | ||
```yml | ||
on: | ||
issue_comment: | ||
types: [created] | ||
|
||
jobs: | ||
hello_world_job: | ||
runs-on: ubuntu-latest | ||
name: Job for toggling label | ||
steps: | ||
- name: Toggle label | ||
uses: jd-0001/[email protected] | ||
with: | ||
label: question | ||
ignore-label: internal | ||
``` | ||
### Only toggle label if specified label is present on issue | ||
```yml | ||
on: | ||
issue_comment: | ||
types: [created] | ||
|
||
jobs: | ||
hello_world_job: | ||
runs-on: ubuntu-latest | ||
name: Job for toggling label | ||
steps: | ||
- name: Toggle label | ||
uses: jd-0001/[email protected] | ||
with: | ||
label: question | ||
only-if-label: support | ||
``` | ||
### Ignore removing label if mentioned users comment on issue and still present in `member-association` | ||
|
||
```yml | ||
on: | ||
issue_comment: | ||
types: [created] | ||
jobs: | ||
hello_world_job: | ||
runs-on: ubuntu-latest | ||
name: Job for toggling label | ||
steps: | ||
- name: Toggle label | ||
uses: jd-0001/[email protected] | ||
with: | ||
label: question | ||
exclude-members: jd-0001, johnDoe123 | ||
``` |
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
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
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