Add work item linkage information to job summary and notices #93
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The action was linking work items to pull requests but not providing clear visibility into which work items were linked. The TODO comments in the code highlighted this gap:
This made it difficult for users to quickly see what work items were associated with their PRs without digging through logs.
Solution
This PR adds visibility for work item linkages through two GitHub Actions features:
1. GitHub Actions Notices
Notice annotations now appear in the workflow run for each linked work item:
::notice title=Work Item Linked::Work item AB#12345 (from commit abc123d) linked to pull request #42
::notice title=Work Item Linked::Pull request linked to work item AB#12345
These notices appear in the workflow annotations UI, making them immediately visible when viewing the workflow run.
2. Job Summary
Work item linkages are added to
$GITHUB_STEP_SUMMARY
, creating a consolidated list on the job summary page:- Work item AB#12345 (from commit abc123d) linked to pull request #42
- Pull request #42 linked to work item AB#12345
This provides a quick reference of all work items associated with the PR in one place.
Changes
Testing
✅ All 36 tests passing (33 bash + 3 JavaScript)
New tests verify:
Impact
Users will now have immediate visibility into work item linkages through:
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
dev.azure.com
node /home/REDACTED/work/azdo_commit_message_validator/azdo_commit_message_validator/node_modules/.bin/jest
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.