Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@balazsorban44
balazsorban44 authored Oct 2, 2023
1 parent 16b29c9 commit a2d4693
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,18 @@ nissuer comes with a default configuration, but you can override certain behavio
- nissuer can label issues based on the content of an issue. Add a select input, and nissuer will add a label based on the selection.
- nissuer can comment on issues based on labels on behalf of a maintainer. Avoid having to repeat yourself by writing up a comment for common cases

| Input | Description | Default Value |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| `label-comments` | Autocomment on issues based on the added label. It should be a JSON object, where the key is a label, and the value is a file path or a comment text. | `{"invalid reproduction": ".github/invalid-reproduction.md"}` |
| `label-area-prefix` | Only look for these labels when autolabeling based on the user selection. | `area:` |
| `label-area-section` | A regular expression string with "(.\*)" matching a section in the issue body to look for user-selected areas. The result is trimmed. | |

| Input | Description | Default Value |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| `label-comments` | Autocomment on issues based on the added label. It should be a JSON object, where the key is a label, and the value is a file path or a comment text. | `{"invalid reproduction": ".github/invalid-reproduction.md"}` |
| `label-area-prefix` | Only look for these labels when autolabeling based on the user selection. | `area:` |
| `label-area-section` | A regular expression string with "(.\*)" matching a section in the issue body to look for user-selected areas. The result is trimmed. Labeling is skipped if this is not configured | |


### Notify about public security disclosures

nissuer can detect if an issue about a potential vulnerability might have been opened publicly by accident and notify the maintainer about it.
nissuer can also delete the issue automatically and send you all the details via a webhook. This can help avoid staying up late at night to fix a vulnerability that was not disclosed responsibly.
- nissuer can detect if an issue about a potential vulnerability might have been opened publicly by accident and notify the maintainer about it.
- nissuer can also delete the issue automatically and send you all the details via a webhook. This can help avoid staying up late at night to fix a vulnerability that was not disclosed responsibly.

| Input | Description | Default Value |
| ----------------------------- | ---------------------------------------------------------------- | ------------- |
Expand Down

0 comments on commit a2d4693

Please sign in to comment.