Skip to content

Enhance check summary rendering with clickable link to individual check details URL - #115

Merged
wechuli merged 11 commits into
mainfrom
wechuli/add-check-links
Aug 21, 2026
Merged

wechuli merged 11 commits into
mainfrom
wechuli/add-check-links

Conversation

@wechuli

@wechuli wechuli commented Aug 21, 2026 •

Copy link
Copy Markdown
Owner

From discussion at #114

This pull request enhances the rendering of check IDs in job and commit status summaries by displaying them as clickable links when a details URL is available. It also introduces a utility for HTML escaping to ensure safe rendering in markdown tables. In addition, there are minor code style improvements and expanded test coverage to verify the new behavior.

Enhancements to summary rendering:

  • Added a new escapeHtml utility function and a formatCheckIdForSummary function in src/checks/checks.ts to safely render check IDs as HTML links if a URL is available. This ensures that check IDs in the summary tables are clickable and secure.
  • Updated the logic for generating summary tables so that both GitHub Actions checks and commit status checks display their IDs as links when details_url or target_url is present.

Test coverage improvements:

  • Added new tests in __tests__/checks/checks.test.ts to verify that check IDs are rendered as links in the summary when a details or target URL is provided, for both GitHub Actions checks and commit status checks. [1] [2]

Copilot AI lite review requested due to automatic review settings August 21, 2026 06:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Enhances check summaries with clickable, HTML-escaped links to check details.

Changes:

  • Adds details_url and target_url fields.
  • Updates summary rendering and generated bundles.
  • Adds link-rendering tests.
  • Requires restricting emitted URLs to http:/https: or falling back to plain IDs.

Reviewed changes

Copilot reviewed 4 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Summary
src/statuses/statusesInterfaces.ts Adds status target URL typing.
src/checks/checksInterfaces.ts Adds check detail URL typing.
src/checks/checks.ts Formats linked check IDs and updates summaries.
dist/index.js Updated bundled runtime.
dist/checks/checks.js.map Updated source map.
dist/checks/checks.js Updated compiled checks logic.
__tests__/checks/checks.test.ts Tests linked check and status IDs.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/checks/checks.ts Outdated
wechuli and others added 3 commits August 21, 2026 09:35
@wechuli
wechuli merged commit e4240aa into main Aug 21, 2026
5 checks passed
@wechuli
wechuli deleted the wechuli/add-check-links branch August 21, 2026 07:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants