docs: update readme and action

balazsorban44 · Nov 29, 2023 · 6163c40 · 6163c40
1 parent 16db6f8
commit 6163c40
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 11 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -17,6 +17,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Nissuer
-        uses: balazsorban44/nissuer@1.7.3
+        uses: balazsorban44/nissuer@1.8.0
         with:
           label-area-section: 'Which area\(s\) are affected\?(.*)'
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ nissuer comes with a default configuration, but you can override certain behavio
 
 ### Handle unhelpful comments
 
-- 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))
+- 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.
 - 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.
 
 | Input                      | Description                                                                        | Default Value |
@@ -21,14 +21,16 @@ nissuer comes with a default configuration, but you can override certain behavio
 ### Validate reproduction URLs
 
 - nissuer can close/comment/label/lock issues that do not have a valid reproduction URL
+- nissuer validates the returned status code of a reproduction URL (for example a private GitHub repository will not be considered valid)
 
-| Input                        | Description                                                                                                                    | Default Value                                  |
-| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
-| `reproduction-comment`       | Either a string or a path to a .md file inside the repository.                                                                 | `.github/invalid-reproduction.md`              |
-| `reproduction-hosts`         | Comma-separated list of hostnames allowed for reproductions.                                                                   | `github.com`                                   |
-| `reproduction-invalid-label` | Label to apply to issues without a valid reproduction.                                                                         | `invalid-reproduction`                         |
-| `reproduction-issue-labels`  | Comma-separated list of issue labels. If configured, only verify reproduction URLs of issues with one of these labels present. |                                                |
-| `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` |
+| Input                        | Description                                                                                                                                 | Default Value                                  |
+| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
+| `reproduction-comment`       | Either a string or a path to a .md file inside the repository.                                                                              | `.github/invalid-reproduction.md`              |
+| `reproduction-hosts`         | Comma-separated list of hostnames allowed for reproductions.                                                                                | `github.com`                                   |
+| `reproduction-blocklist`     | Comma-separated list of regular expression string that are not allowed for reproductions. (Eg.: "github.com/.\*/fork-of-non-reproduction"') |                                                |
+| `reproduction-invalid-label` | Label to apply to issues without a valid reproduction.                                                                                      | `invalid-reproduction`                         |
+| `reproduction-issue-labels`  | Comma-separated list of issue labels. If configured, only verify reproduction URLs of issues with one of these labels present.              |                                                |
+| `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` |
 
 ### Label Management
 
@@ -76,7 +78,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Nissuer
-        uses: balazsorban44/nissuer@1.7.3
+        uses: balazsorban44/nissuer@1.8.0
 ```
 
 Add a comment file (by default we look for `.github/invalid-reproduction.md`):

diff --git a/action.yml b/action.yml
@@ -19,7 +19,7 @@ inputs:
     description: 'Comma-separated list of hostnames that are allowed for reproductions. Example: "github.com,codesandbox.io"'
     default: github.com
   reproduction-blocklist:
-    description: 'Comma-separated list of URLs that are not allowed for reproductions. They can be regular expression string. Example: "github.com/.*/fork-of-example"'
+    description: 'Comma-separated list of regular expression string that are not allowed for reproductions. Example: "github.com/.*/fork-of-example"'
     default: ''
   reproduction-invalid-label:
     description: 'Label to apply to issues without a valid reproduction. Example: "invalid-reproduction"'