Skip to content

feat: add status marks for the Action's report - #77

Merged
shenxianpeng merged 1 commit into
mainfrom
feature/status-icons
Nov 11, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
feature/status-icons

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Adds the Commit Check mark in four status colours, so the Action's job summary and PR comment can show the result with our own mark instead of an emoji.

passed failed warned skipped
Heading, 24 px
Line, 16 px
  • branding/status/<state>.svg and .png: the mark on its Ink tile, the commit on its history line with a tick, cross, exclamation mark or dash. For a report heading.
  • branding/status/line-<state>.svg and .png: the commit and its verdict without the tile. For one line of a report; the background is transparent, so it works in light and dark themes.
  • branding/src/render.sh renders the PNGs from the SVGs, and branding/README.md lists the new files.

commit-check-action will link to the PNGs on main, so these paths should stay where they are once merged.

Summary by CodeRabbit

  • New Features

    • Added tiled status images for report headings and untiled marks for individual report lines, with distinct visuals for passed, failed, warned, and skipped statuses.
    • Added PNG versions of each status image for use in reports.
  • Documentation

    • Documented the image variants and their use in job summaries and pull request comments.
    • Clarified that existing report links may break if the image files are moved or renamed.

The mark in four status colours (passed, failed, warned, skipped), as a
tile for a report heading and without the tile for a single line.
@shenxianpeng shenxianpeng self-assigned this Nov 11, 2026
@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The render script now generates tiled and line PNGs for four status states. The README documents their sizes, report usage, and links.

Changes: Status image generation and documentation

Layer / File(s) Summary
Generate and document status image variants
branding/src/render.sh, branding/README.md
The render script generates tiled status images at 96×96 and line images at 64×64 for four states. The README describes their report usage, verdict variants, and links to PNGs on main.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Feature

Merge Risk: Minimal · up to e86d4

This adds status image assets and documentation with no runtime behavior change. It is ready to merge, provided the asset paths on main stay stable for the action.

Pre-merge checks: Passed 5

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: adding status marks for the Action's report.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 1 files. (1 skipped: 1 unsupported.)

Finishing Touches

Generate docstrings

  • Commit to this branch
  • Create a new PR
Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 56e322d8-8c20-4b65-a160-e03da78d26ad
Commits

Reviewing files that changed from the base of the PR and between e8435e1 and e86d40e.

Files ignored due to path filters: 16

  • branding/status/failed.png is excluded by !**/*.png
  • branding/status/failed.svg is excluded by !**/*.svg
  • branding/status/line-failed.png is excluded by !**/*.png
  • branding/status/line-failed.svg is excluded by !**/*.svg
  • branding/status/line-passed.png is excluded by !**/*.png
  • branding/status/line-passed.svg is excluded by !**/*.svg
  • branding/status/line-skipped.png is excluded by !**/*.png
  • branding/status/line-skipped.svg is excluded by !**/*.svg
  • branding/status/line-warned.png is excluded by !**/*.png
  • branding/status/line-warned.svg is excluded by !**/*.svg
  • branding/status/passed.png is excluded by !**/*.png
  • branding/status/passed.svg is excluded by !**/*.svg
  • branding/status/skipped.png is excluded by !**/*.png
  • branding/status/skipped.svg is excluded by !**/*.svg
  • branding/status/warned.png is excluded by !**/*.png
  • branding/status/warned.svg is excluded by !**/*.svg
Files selected for processing: 2

  • branding/README.md
  • branding/src/render.sh

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@github-actions

Copy link
Copy Markdown

Commit Check

✅ All 3 checks passed

Show all 3 checks
Commit message
  ✔ PR title (feat: add status marks for the Action's report)
  ✔ Commit 1/1 (e86d40e) (feat: add status marks for the Action's report)
Branch
  ✔ Branch (feature/status-icons)

commit-check 2.19.3 · Rules reference

@shenxianpeng
shenxianpeng merged commit f11277e into main Nov 11, 2026
4 checks passed
@shenxianpeng
shenxianpeng deleted the feature/status-icons branch November 11, 2026 11:30
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.

1 participant