Skip to content

ci(gittensor): add impact card workflow and readme badge#408

Merged
plind-junior merged 1 commit into
mainfrom
feat/gittensor-impact-badge
Jul 7, 2026
Merged

ci(gittensor): add impact card workflow and readme badge#408
plind-junior merged 1 commit into
mainfrom
feat/gittensor-impact-badge

Conversation

@plind-junior

@plind-junior plind-junior commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

adds gittensor contributor-impact visibility to the repo, in two parts:

  • a badge in the readme badge row, served directly by api.gittensor.io
    (github proxies the image, so it refreshes every few hours rather than
    in real time).
  • a scheduled .github/workflows/gittensor-impact.yml that runs
    matthewevans/gittensor-impact-action to render the fuller dark/light
    impact cards and publish them as gittensor-impact release assets.

the workflow uses a third-party composite action, so it is pinned to the
v1.1.4 commit sha (cc83f449) rather than a mutable @v1 tag, and the
job grants only contents: write with permissions: {} at the top
level — no ambient token scopes. it triggers on a weekly schedule and
workflow_dispatch, with no untrusted event inputs.

follow-up after the first run: once the workflow publishes the release
assets, the fuller card can be embedded in the readme via the <picture>
snippet pointing at the release-download urls.

Summary by CodeRabbit

  • New Features
    • Added a weekly and manually runnable “Gittensor Impact” workflow that generates and publishes impact cards as release assets.
    • Updated the project header with a new “Gittensor impact” badge link for quick access.

surfaces gittensor contributor-impact on the repo: a badge in the readme
badge row (served by api.gittensor.io) and a scheduled workflow that runs
matthewevans/gittensor-impact-action to render and publish the fuller
dark/light impact cards as release assets.

the third-party action is pinned to the v1.1.4 commit sha rather than a
mutable tag, and the job opts into only contents: write with no ambient
token scopes, so an upstream retag cannot change what runs in ci.
@github-actions github-actions Bot added docs documentation, specs, examples, and repo guidance ci github actions and automation size: XS less than 50 changed non-doc lines labels Jul 7, 2026
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Adds a new GitHub Actions workflow (gittensor-impact.yml) that runs weekly and on manual dispatch to render and publish a contributor-impact SVG card as a release asset via a pinned third-party action, and adds a corresponding badge link in README.md.

Changes

Gittensor Impact Badge

Layer / File(s) Summary
Gittensor Impact workflow and README badge
.github/workflows/gittensor-impact.yml, README.md
New workflow triggers weekly (Monday 14:00 cron) and via manual dispatch, sets default permissions to none, grants contents: write to the job, and uses a pinned matthewevans/gittensor-impact-action with accent/neutral color and title inputs to publish a release-card SVG; README adds a badge linking to the impact page.

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

Poem

A rabbit hops with weekly cheer,
A workflow born to publish here,
Colors set, a title bright,
Contributors shine in light,
A badge now sits atop the page—
Impact rendered, front and center stage.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main changes: adding a Gittensor impact workflow and a README badge.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/gittensor-impact-badge

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

Comment @coderabbitai help to get the list of available commands.

@plind-junior plind-junior merged commit 759d240 into main Jul 7, 2026
10 of 11 checks passed

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
.github/workflows/gittensor-impact.yml (1)

15-19: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick win

Consider adding a job timeout.

No timeout-minutes is set; a hang in the third-party action would consume runner minutes indefinitely.

Proposed addition
   update:
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     permissions:
       contents: write # publish the rendered svg cards to release assets
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.github/workflows/gittensor-impact.yml around lines 15 - 19, Add a timeout
to the update job in the GitHub Actions workflow so a hung third-party step
cannot run indefinitely. Update the job definition for the update job to include
a sensible timeout-minutes value alongside runs-on, permissions, and steps,
keeping the change localized to that workflow job.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In @.github/workflows/gittensor-impact.yml:
- Around line 15-19: Add a timeout to the update job in the GitHub Actions
workflow so a hung third-party step cannot run indefinitely. Update the job
definition for the update job to include a sensible timeout-minutes value
alongside runs-on, permissions, and steps, keeping the change localized to that
workflow job.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 9aed8363-80d9-40db-9045-b40047723982

📥 Commits

Reviewing files that changed from the base of the PR and between 36f035e and 671f41d.

📒 Files selected for processing (2)
  • .github/workflows/gittensor-impact.yml
  • README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci github actions and automation docs documentation, specs, examples, and repo guidance size: XS less than 50 changed non-doc lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant