Skip to content

Commit 247cf6e

Browse files
author
alt-13
committed
Accept both linked issue formats
1 parent 30026d1 commit 247cf6e

File tree

3 files changed

+267
-53
lines changed

3 files changed

+267
-53
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ GitHub action to check if pull requests have their corresponding issues linked,
44

55
## Inputs
66

7-
| input | required | default | description |
8-
|----------------------------|----|---------------------|------------------------------------------------------------------|
9-
| `github-token` | No | `${{github.token}}` | Your Github token, it's already available to your Github action. |
10-
| `exclude-branches` | No | `''` | A comma-separated list of patterns to ignore source branches. (Any pattern supported by `minimatch`). |
11-
| `exclude-labels` | No | `''` | A comma-separated list of labels to ignore. |
12-
| `comment` | No | `true` | A boolean value that allow the action to create a comment. |
13-
| `custom-body-comment` | No | "No linked issues found. Please add the corresponding issues in the pull request description. <br/> [Use GitHub automation to close the issue when a PR is merged](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)" | Custom body PR comment. |
14-
| `loose-matching` | No | `false` | A boolean value indicating whether the action should verify linked issues inside a PR's description, merging onto any branch (including non-default branches like `main` or `master`). When enabled, this option supports both local issues (e.g., `#123`) and external ones (e.g., `https://github.com/org-name/repo/issues/123`). Associating a pull request with an issue requires the use of any of the [supported keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) in the pull request's description (e.g., `fixes #123`).|
7+
| input | required | default | description |
8+
|----------------------------|----|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
9+
| `github-token` | No | `${{github.token}}` | Your Github token, it's already available to your Github action. |
10+
| `exclude-branches` | No | `''` | A comma-separated list of patterns to ignore source branches. (Any pattern supported by `minimatch`). |
11+
| `exclude-labels` | No | `''` | A comma-separated list of labels to ignore. |
12+
| `comment` | No | `true` | A boolean value that allow the action to create a comment. |
13+
| `custom-body-comment` | No | "No linked issues found. Please add the corresponding issues in the pull request description. <br/> [Use GitHub automation to close the issue when a PR is merged](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)" | Custom body PR comment. |
14+
| `loose-matching` | No | `false` | A boolean value indicating whether the action should verify linked issues inside a PR's description, merging onto any branch (including non-default branches like `main` or `master`). When enabled, this option supports both local issues (e.g., `#123`) and external ones (e.g., `https://github.com/org-name/repo/issues/123` or `org-name/repo#123`). Associating a pull request with an issue requires the use of any of the [supported keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) in the pull request's description (e.g., `fixes #123`). |
1515

1616
## Outputs
1717

0 commit comments

Comments
 (0)