feat: add pull-request-check-scope input to control where AB# is checked (#149)

joshjohanning · web-flow · commit bdbe8c0ec605 · 2026-03-06T15:00:29.000-06:00
* feat: add `pull-request-check-scope` input to control where AB# is checked closes #146 * chore: update package-lock.json * fix: align descriptions and defaults for check-pull-request across action.yml, README, and JSDoc
diff --git a/README.md b/README.md
@@ -65,7 +65,8 @@ jobs:
 
 | Name                                   | Description                                                                                                                                       | Required | Default               |
 | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------- |
-| `check-pull-request`                   | Check the pull request body and title for `AB#xxx`                                                                                                | `true`   | `true`                |
+| `check-pull-request`                   | Check the pull request for `AB#xxx` (scope configurable via `pull-request-check-scope`)                                                           | `true`   | `false`               |
+| `pull-request-check-scope`             | Only if `check-pull-request=true`, where to look for `AB#` in the PR: `title-or-body`, `body-only`, or `title-only`                               | `false`  | `title-or-body`       |
 | `check-commits`                        | Check each commit in the pull request for `AB#xxx`                                                                                                | `true`   | `true`                |
 | `fail-if-missing-workitem-commit-link` | Only if `check-commits=true`, fail the action if a commit in the pull request is missing AB# in every commit message                              | `false`  | `true`                |
 | `link-commits-to-pull-request`         | Only if `check-commits=true`, link the work items found in commits to the pull request                                                            | `false`  | `true`                |
diff --git a/__tests__/index.test.js b/__tests__/index.test.js
@@ -9,6 +9,7 @@ const mockGetInput = jest.fn();
 const mockSetFailed = jest.fn();
 const mockInfo = jest.fn();
 const mockError = jest.fn();
+const mockWarning = jest.fn();
 const mockSummary = {
   addRaw: jest.fn().mockReturnThis(),
   write: jest.fn().mockResolvedValue(undefined)
@@ -19,6 +20,7 @@ jest.unstable_mockModule('@actions/core', () => ({
   setFailed: mockSetFailed,
   info: mockInfo,
   error: mockError,
+  warning: mockWarning,
   summary: mockSummary
 }));
 
@@ -77,6 +79,7 @@ describe('Azure DevOps Commit Validator', () => {
     mockGetInput.mockImplementation(name => {
       const defaults = {
         'check-pull-request': 'false',
+        'pull-request-check-scope': 'title-or-body',
         'check-commits': 'true',
         'fail-if-missing-workitem-commit-link': 'true',
         'link-commits-to-pull-request': 'false',
@@ -634,6 +637,171 @@ describe('Azure DevOps Commit Validator', () => {
     });
   });
 
+  describe('Pull request check scope', () => {
+    it('should pass with body-only scope when work item is in body', async () => {
+      mockGetInput.mockImplementation(name => {
+        if (name === 'check-commits') return 'false';
+        if (name === 'check-pull-request') return 'true';
+        if (name === 'pull-request-check-scope') return 'body-only';
+        if (name === 'github-token') return 'github-token';
+        if (name === 'comment-on-failure') return 'false';
+        return 'false';
+      });
+
+      mockOctokit.rest.pulls.get.mockResolvedValue({
+        data: {
+          title: 'feat: new feature',
+          body: 'This PR implements AB#12345'
+        }
+      });
+
+      await run();
+
+      expect(mockSetFailed).not.toHaveBeenCalled();
+    });
+
+    it('should fail with body-only scope when work item is only in title', async () => {
+      mockGetInput.mockImplementation(name => {
+        if (name === 'check-commits') return 'false';
+        if (name === 'check-pull-request') return 'true';
+        if (name === 'pull-request-check-scope') return 'body-only';
+        if (name === 'github-token') return 'github-token';
+        if (name === 'comment-on-failure') return 'false';
+        return 'false';
+      });
+
+      mockOctokit.rest.pulls.get.mockResolvedValue({
+        data: {
+          title: 'feat: new feature AB#12345',
+          body: 'This is a test PR'
+        }
+      });
+
+      await run();
+
+      expect(mockSetFailed).toHaveBeenCalled();
+    });
+
+    it('should pass with title-only scope when work item is in title', async () => {
+      mockGetInput.mockImplementation(name => {
+        if (name === 'check-commits') return 'false';
+        if (name === 'check-pull-request') return 'true';
+        if (name === 'pull-request-check-scope') return 'title-only';
+        if (name === 'github-token') return 'github-token';
+        if (name === 'comment-on-failure') return 'false';
+        return 'false';
+      });
+
+      mockOctokit.rest.pulls.get.mockResolvedValue({
+        data: {
+          title: 'feat: new feature AB#12345',
+          body: 'This is a test PR'
+        }
+      });
+
+      await run();
+
+      expect(mockSetFailed).not.toHaveBeenCalled();
+    });
+
+    it('should fail with title-only scope when work item is only in body', async () => {
+      mockGetInput.mockImplementation(name => {
+        if (name === 'check-commits') return 'false';
+        if (name === 'check-pull-request') return 'true';
+        if (name === 'pull-request-check-scope') return 'title-only';
+        if (name === 'github-token') return 'github-token';
+        if (name === 'comment-on-failure') return 'false';
+        return 'false';
+      });
+
+      mockOctokit.rest.pulls.get.mockResolvedValue({
+        data: {
+          title: 'feat: new feature',
+          body: 'This PR implements AB#12345'
+        }
+      });
+
+      await run();
+
+      expect(mockSetFailed).toHaveBeenCalled();
+    });
+
+    it('should pass with title-or-body scope (default) when work item is in either', async () => {
+      mockGetInput.mockImplementation(name => {
+        if (name === 'check-commits') return 'false';
+        if (name === 'check-pull-request') return 'true';
+        if (name === 'pull-request-check-scope') return 'title-or-body';
+        if (name === 'github-token') return 'github-token';
+        if (name === 'comment-on-failure') return 'false';
+        return 'false';
+      });
+
+      mockOctokit.rest.pulls.get.mockResolvedValue({
+        data: {
+          title: 'feat: new feature AB#12345',
+          body: 'This is a test PR'
+        }
+      });
+
+      await run();
+
+      expect(mockSetFailed).not.toHaveBeenCalled();
+    });
+
+    it('should warn and use default scope with invalid pull-request-check-scope value', async () => {
+      mockGetInput.mockImplementation(name => {
+        if (name === 'check-commits') return 'false';
+        if (name === 'check-pull-request') return 'true';
+        if (name === 'pull-request-check-scope') return 'invalid-value';
+        if (name === 'github-token') return 'github-token';
+        if (name === 'comment-on-failure') return 'false';
+        return 'false';
+      });
+
+      mockOctokit.rest.pulls.get.mockResolvedValue({
+        data: {
+          title: 'feat: new feature AB#12345',
+          body: 'Test body'
+        }
+      });
+
+      await run();
+
+      expect(mockWarning).toHaveBeenCalledWith(
+        expect.stringContaining("Invalid value 'invalid-value' for 'pull-request-check-scope'")
+      );
+      // Should still pass because it falls back to title-or-body and title has AB#
+      expect(mockSetFailed).not.toHaveBeenCalled();
+    });
+
+    it('should include scope-aware message in failure comment with body-only scope', async () => {
+      mockGetInput.mockImplementation(name => {
+        if (name === 'check-commits') return 'false';
+        if (name === 'check-pull-request') return 'true';
+        if (name === 'pull-request-check-scope') return 'body-only';
+        if (name === 'github-token') return 'github-token';
+        if (name === 'comment-on-failure') return 'true';
+        return 'false';
+      });
+
+      mockOctokit.rest.pulls.get.mockResolvedValue({
+        data: {
+          title: 'feat: new feature AB#12345',
+          body: 'This is a test PR without work item in body'
+        }
+      });
+
+      await run();
+
+      expect(mockSetFailed).toHaveBeenCalled();
+      expect(mockOctokit.rest.issues.createComment).toHaveBeenCalledWith(
+        expect.objectContaining({
+          body: expect.stringContaining('Please update the body to include a work item')
+        })
+      );
+    });
+  });
+
   describe('Comment management', () => {
     it('should not comment when comment-on-failure is false', async () => {
       mockGetInput.mockImplementation(name => {
diff --git a/action.yml b/action.yml
@@ -7,9 +7,13 @@ branding:
 
 inputs:
   check-pull-request:
-    description: 'Check the pull request body and title for AB#xxx'
+    description: 'Check the pull request for AB#xxx (scope configurable via pull-request-check-scope)'
     required: true
     default: 'false'
+  pull-request-check-scope:
+    description: 'Only if check-pull-request=true, where to look for AB# in the pull request. Options: title-or-body, body-only, title-only'
+    required: false
+    default: 'title-or-body'
   check-commits:
     description: 'Check each commit in the pull request for AB#xxx'
     required: true
diff --git a/badges/coverage.svg b/badges/coverage.svg
@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="116" height="20" role="img" aria-label="Coverage: 81.08%"><title>Coverage: 81.08%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="116" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="63" height="20" fill="#333"/><rect x="63" width="53" height="20" fill="#a0a127"/><rect width="116" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="325" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">Coverage</text><text x="325" y="140" transform="scale(.1)" fill="#fff" textLength="530">Coverage</text><text aria-hidden="true" x="885" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">81.08%</text><text x="885" y="140" transform="scale(.1)" fill="#fff" textLength="430">81.08%</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="116" height="20" role="img" aria-label="Coverage: 81.91%"><title>Coverage: 81.91%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="116" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="63" height="20" fill="#333"/><rect x="63" width="53" height="20" fill="#a0a127"/><rect width="116" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="325" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="530">Coverage</text><text x="325" y="140" transform="scale(.1)" fill="#fff" textLength="530">Coverage</text><text aria-hidden="true" x="885" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">81.91%</text><text x="885" y="140" transform="scale(.1)" fill="#fff" textLength="430">81.91%</text></g></svg>
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "azure-devops-work-item-link-enforcer-and-linker",
-  "version": "3.0.13",
+  "version": "3.1.0",
   "private": true,
   "type": "module",
   "description": "GitHub Action to enforce that each commit in a pull request be linked to an Azure DevOps work item and automatically link the pull request to each work item ",
diff --git a/src/index.js b/src/index.js
@@ -30,6 +30,11 @@ export async function run() {
   try {
     // Get inputs
     const checkPullRequest = core.getInput('check-pull-request') === 'true';
+    const validScopes = ['title-or-body', 'body-only', 'title-only'];
+    const pullRequestCheckScopeRaw = core.getInput('pull-request-check-scope');
+    const pullRequestCheckScope = validScopes.includes(pullRequestCheckScopeRaw)
+      ? pullRequestCheckScopeRaw
+      : 'title-or-body';
     const checkCommits = core.getInput('check-commits') === 'true';
     const failIfMissingWorkitemCommitLink = core.getInput('fail-if-missing-workitem-commit-link') === 'true';
     const linkCommitsToPullRequest = core.getInput('link-commits-to-pull-request') === 'true';
@@ -39,6 +44,13 @@ export async function run() {
     const commentOnFailure = core.getInput('comment-on-failure') === 'true';
     const validateWorkItemExistsFlag = core.getInput('validate-work-item-exists') === 'true';
 
+    // Warn if an invalid scope value was provided
+    if (checkPullRequest && pullRequestCheckScopeRaw && !validScopes.includes(pullRequestCheckScopeRaw)) {
+      core.warning(
+        `Invalid value '${pullRequestCheckScopeRaw}' for 'pull-request-check-scope'. Using default 'title-or-body'. Valid values are: ${validScopes.join(', ')}`
+      );
+    }
+
     // Validate that at least one check is enabled
     if (!checkPullRequest && !checkCommits) {
       core.setFailed(
@@ -108,7 +120,8 @@ export async function run() {
         validateWorkItemExistsFlag,
         azureDevopsOrganization,
         azureDevopsToken,
-        workItemToCommitMap
+        workItemToCommitMap,
+        pullRequestCheckScope
       );
     }
 
@@ -415,7 +428,8 @@ async function checkCommitsForWorkItems(
  * @param {string} azureDevopsOrganization - Azure DevOps organization name
  * @param {string} azureDevopsToken - Azure DevOps PAT token
  * @param {Map} workItemToCommitMap - Map of work item IDs to commit info from checkCommitsForWorkItems
- * @returns {Array} Returns array of invalid work item IDs found in PR title/body
+ * @param {string} pullRequestCheckScope - Where to look for AB# in the PR: 'title-or-body', 'body-only', or 'title-only'
+ * @returns {Array} Returns array of invalid work item IDs found in the PR based on pullRequestCheckScope
  */
 async function checkPullRequestForWorkItems(
   octokit,
@@ -425,7 +439,8 @@ async function checkPullRequestForWorkItems(
   validateWorkItemExistsFlag,
   azureDevopsOrganization,
   azureDevopsToken,
-  workItemToCommitMap
+  workItemToCommitMap,
+  pullRequestCheckScope = 'title-or-body'
 ) {
   const { owner, repo } = context.repo;
 
@@ -439,11 +454,32 @@ async function checkPullRequestForWorkItems(
   const pullBody = pullRequest.data.body || '';
   const pullTitle = pullRequest.data.title || '';
 
+  // Determine which text to check based on pull-request-check-scope
+  let textToCheck;
+  let scopeDescription;
+  switch (pullRequestCheckScope) {
+    case 'body-only':
+      textToCheck = pullBody;
+      scopeDescription = 'body';
+      break;
+    case 'title-only':
+      textToCheck = pullTitle;
+      scopeDescription = 'title';
+      break;
+    case 'title-or-body':
+    default:
+      textToCheck = `${pullTitle} ${pullBody}`;
+      scopeDescription = 'title or body';
+      break;
+  }
+
+  core.info(`Checking PR ${scopeDescription} for work item links (scope: ${pullRequestCheckScope})`);
+
   // Define common comment text patterns
   const FAILURE_COMMENT_TEXT = ':x: This pull request is not linked to a work item.';
   const SUCCESS_COMMENT_TEXT = ':white_check_mark: This pull request is now linked to a work item.';
 
-  if (!AB_PATTERN.test(`${pullTitle} ${pullBody}`)) {
+  if (!AB_PATTERN.test(textToCheck)) {
     core.info('PR not linked to a work item');
     core.error(
       `Pull Request not linked to work item(s): The pull request #${pullNumber} is not linked to any work item(s)`
@@ -455,7 +491,7 @@ async function checkPullRequestForWorkItems(
         octokit,
         context,
         pullNumber,
-        `${FAILURE_COMMENT_TEXT} Please update the title or body to include a work item and re-run the failed job to continue. Any new commits to the pull request will also re-run the job.`,
+        `${FAILURE_COMMENT_TEXT} Please update the ${scopeDescription} to include a work item and re-run the failed job to continue. Any new commits to the pull request will also re-run the job.`,
         FAILURE_COMMENT_TEXT
       );
     }
@@ -489,8 +525,8 @@ async function checkPullRequestForWorkItems(
       core.info('... PR comment updated to success');
     }
 
-    // Extract work items from PR body and title and validate they exist
-    const workItems = `${pullBody} ${pullTitle}`.match(AB_PATTERN);
+    // Extract work items from the checked scope and validate they exist
+    const workItems = textToCheck.match(AB_PATTERN);
     if (workItems) {
       const uniqueWorkItems = [...new Set(workItems)];
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "azure-devops-work-item-link-enforcer-and-linker",`
`3`		`- "version": "3.0.13",`
	`3`	`+ "version": "3.1.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"type": "module",`
`6`	`6`	`"description": "GitHub Action to enforce that each commit in a pull request be linked to an Azure DevOps work item and automatically link the pull request to each work item ",`