fix(ci): coverage comment no longer autolinks to a fake domain#38
Merged
fix(ci): coverage comment no longer autolinks to a fake domain#38
Conversation
v0.9.8's coverage job named the workflow artifact after the standard
lcov-output filename and rendered the same string in its sticky PR
comment. In GitHub's web UI the backticks rendered the token as
inline code; in email and feed clients, however, re-renderers strip
backticks and run their own autolinker over the plain text. Because
the filename's extension is a registered TLD, every notification
email turned the literal artifact-name into a hyperlink to a real,
unrelated parked domain. Reported by the maintainer after spot-
checking the v0.9.8 release-notification email.
Three changes:
- Rename the workflow artifact to `coverage-lcov`. The on-disk
filename stays unchanged so lcov-consuming tools (vscode-
coverage-gutters, codecov, etc.) still find it inside the
artifact bundle.
- Replace the bare token in the sticky comment with a real link
to the workflow run's artifacts tab. Email readers now have a
safe destination to follow instead of the autolinked TLD.
- Update CONTRIBUTING.md and CHANGELOG.md to use the new
artifact name and avoid the bare token where the docs feed
user-visible surfaces (release-notes emails, RSS).
Internal references in ci.yml (`--output-path`, `path:`, shell
parsing) keep the on-disk filename — they're never rendered to
email and changing them would break tooling that consumes the
lcov format.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Coverage reportLine coverage: 85.7% (9157 / 10679 lines) Full lcov report available as workflow artifact coverage-lcov: download from this run. v0.9.8 introduces this report; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Reported behavior
After the v0.9.8 release notification landed in the maintainer's inbox, the coverage-report PR comment was rendering the lcov artifact name as a hyperlink in email — pointing at a real, unrelated parked domain. Exactly the kind of supply-chain-credibility hit a security tool can't afford.
Root cause
The sticky coverage comment includes the workflow artifact name verbatim. In GitHub's web UI the backticks make it inline code, but email and feed clients re-render the comment with their own autolinker that strips backticks and matches anything ending in a registered TLD. Because the standard lcov filename ends in a TLD, the literal token was getting linked to a real, unrelated domain.
Fix
coverage-lcov. The on-disk filename stays unchanged so lcov-consuming tools (vscode-coverage-gutters, codecov, etc.) still find it inside the artifact.#artifactstab. Email readers now have a safe destination.ci.ymlreferences (--output-path,path:, shell parsing) keep the on-disk filename. They're never rendered to email and changing them would break lcov format consumers.Validation
python3 -c "import yaml; yaml.safe_load(open('.github/workflows/ci.yml'))"parses clean.