Link the job summary back to the PatchRail repo - #10
Merged
Conversation
The annotation and job summary are the only surface a maintainer reading their own failed run sees, and neither pointed back at the project behind them. Add a plain repo backlink to the footer shared by all three summary paths (classified, no-log, unreadable-schema). It is text written to $GITHUB_STEP_SUMMARY, so it keeps the read-only promise: no pull request, no comment, no network. A link, never a star solicitation; test_repo_backlink guards both on every path.
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.
What
Every job summary the action writes now carries a plain backlink to github.com/patchrail/patchrail in its footer.
Why
The GitHub annotation and
$GITHUB_STEP_SUMMARYare the only surface a maintainer reading their own failed run sees. The summary linked out to the per-class fix guide on getpatchrail.com, but never back to the project behind the annotation — a dead end for anyone who wanted to find the tool. This adds that one link.Scope / safety
SUMMARY_FOOTERused by all three summary paths: classified, no-log (--unclassified), and unreadable-schema. This also de-duplicates theClassified locally…closing line, which was copied three times.$GITHUB_STEP_SUMMARYonly — no PR comment, no network call, so the read-only / "nothing leaves the runner" contract is unchanged.tests/test_repo_backlink.pyasserts, on every path, that the backlink is present and that no star/upvote cue ever appears in a summary.Tests
python -m pytest -q→ 41 passed on Python 3.12 with the shippedpatchrail>=0.6.0,<0.8.0(0.7.3).