Skip to content

Commit 4e1fa10

Browse files
authored
chore: remove required GitHub issue linking from PR title validation (#587)
Removes the mandatory #xxx issue reference requirement from PR titles while adding a PR template that encourages linking to existing issues when relevant. One option to close #586; draft pending discussion.
2 parents 1d9e732 + 643fe8f commit 4e1fa10

File tree

2 files changed

+7
-14
lines changed

2 files changed

+7
-14
lines changed

.github/actions/check-input-commit-message/index.js

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,9 @@ async function runCommitlint(message) {
1919
return report.valid;
2020
}
2121

22-
function checkIssueNumber(message) {
23-
console.log(
24-
"Checking for a '#xxx' reference to a corresponding GitHub issue"
25-
);
26-
if (/#[0-9]/.test(message)) {
27-
console.log("Successfully found issue number\n");
28-
return true;
29-
} else {
30-
console.error("Issue number missing\n");
31-
return false;
32-
}
33-
}
34-
3522
async function checkMessage() {
3623
const message = core.getInput("message");
3724
const failedChecks = [];
38-
if (!checkIssueNumber(message)) failedChecks.push("issue number");
3925
if (!(await runCommitlint(message)))
4026
failedChecks.push("Conventional Commits");
4127
if (failedChecks.length > 0)

.github/pull_request_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Description
2+
3+
Brief description of the changes made in this PR.
4+
5+
## Related Issue
6+
7+
If this addresses an existing GitHub issue, link it here (e.g., "Closes #123"). If no existing issue exists, consider creating one first to discuss the changes.

0 commit comments

Comments
 (0)