Skip to content

Commit 6163c40

Browse files
committed
docs: update readme and action
1 parent 16db6f8 commit 6163c40

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ jobs:
1717
runs-on: ubuntu-latest
1818
steps:
1919
- name: Nissuer
20-
uses: balazsorban44/nissuer@1.7.3
20+
uses: balazsorban44/nissuer@1.8.0
2121
with:
2222
label-area-section: 'Which area\(s\) are affected\?(.*)'

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nissuer comes with a default configuration, but you can override certain behavio
1010

1111
### Handle unhelpful comments
1212

13-
- nissuer can hide "+1", "same issue", etc. comments on issues (partially based on [Refined GitHub](https://github.com/refined-github/refined-github/blob/c864a20b57bb433aaf3952f88d83c9fc481ae6ff/source/helpers/is-low-quality-comment.ts#L2-L3))
13+
- nissuer can hide "+1", "same issue", etc. comments on issues (partially based on [Refined GitHub](https://github.com/refined-github/refined-github/blob/c864a20b57bb433aaf3952f88d83c9fc481ae6ff/source/helpers/is-low-quality-comment.ts#L2-L3)). It won't hide comments from the repo organization members.
1414
- nissuer can also update the hidden comment with a note from the maintainers, explaining to the user why the comment was hidden. This is used for education purposes, so hopefully the user will be more considerate in the future.
1515

1616
| Input | Description | Default Value |
@@ -21,14 +21,16 @@ nissuer comes with a default configuration, but you can override certain behavio
2121
### Validate reproduction URLs
2222

2323
- nissuer can close/comment/label/lock issues that do not have a valid reproduction URL
24+
- nissuer validates the returned status code of a reproduction URL (for example a private GitHub repository will not be considered valid)
2425

25-
| Input | Description | Default Value |
26-
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
27-
| `reproduction-comment` | Either a string or a path to a .md file inside the repository. | `.github/invalid-reproduction.md` |
28-
| `reproduction-hosts` | Comma-separated list of hostnames allowed for reproductions. | `github.com` |
29-
| `reproduction-invalid-label` | Label to apply to issues without a valid reproduction. | `invalid-reproduction` |
30-
| `reproduction-issue-labels` | Comma-separated list of issue labels. If configured, only verify reproduction URLs of issues with one of these labels present. | |
31-
| `reproduction-link-section` | A regular expression string with "(.\*)" matching a valid URL in the issue body. The result is trimmed. | `### Link to reproduction(.*)### To reproduce` |
26+
| Input | Description | Default Value |
27+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
28+
| `reproduction-comment` | Either a string or a path to a .md file inside the repository. | `.github/invalid-reproduction.md` |
29+
| `reproduction-hosts` | Comma-separated list of hostnames allowed for reproductions. | `github.com` |
30+
| `reproduction-blocklist` | Comma-separated list of regular expression string that are not allowed for reproductions. (Eg.: "github.com/.\*/fork-of-non-reproduction"') | |
31+
| `reproduction-invalid-label` | Label to apply to issues without a valid reproduction. | `invalid-reproduction` |
32+
| `reproduction-issue-labels` | Comma-separated list of issue labels. If configured, only verify reproduction URLs of issues with one of these labels present. | |
33+
| `reproduction-link-section` | A regular expression string with "(.\*)" matching a valid URL in the issue body. The result is trimmed. | `### Link to reproduction(.*)### To reproduce` |
3234

3335
### Label Management
3436

@@ -76,7 +78,7 @@ jobs:
7678
runs-on: ubuntu-latest
7779
steps:
7880
- name: Nissuer
79-
uses: balazsorban44/nissuer@1.7.3
81+
uses: balazsorban44/nissuer@1.8.0
8082
```
8183

8284
Add a comment file (by default we look for `.github/invalid-reproduction.md`):

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ inputs:
1919
description: 'Comma-separated list of hostnames that are allowed for reproductions. Example: "github.com,codesandbox.io"'
2020
default: github.com
2121
reproduction-blocklist:
22-
description: 'Comma-separated list of URLs that are not allowed for reproductions. They can be regular expression string. Example: "github.com/.*/fork-of-example"'
22+
description: 'Comma-separated list of regular expression string that are not allowed for reproductions. Example: "github.com/.*/fork-of-example"'
2323
default: ''
2424
reproduction-invalid-label:
2525
description: 'Label to apply to issues without a valid reproduction. Example: "invalid-reproduction"'

0 commit comments

Comments
 (0)