Skip to content

kiaquila/comet-contribution-graph

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

comet-contribution-graph

A cinematic GitHub contribution graph. A comet traces your most productive days across a constellation of your year.

comet-graph OSV Scanner code style: prettier License: MIT

cinematic comet contribution graph

Usage

Add the following workflow to your profile repo (<user>/<user>) to render and publish your comet graph on a weekly schedule. The Action fetches your contribution data, renders the SVG, and force-pushes it to a comet-graph branch in the same repo.

# .github/workflows/comet-graph.yml in <user>/<user>
name: comet-graph
on:
  schedule:
    - cron: "0 3 * * 1"
  workflow_dispatch:
jobs:
  render:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6
      - uses: kiaquila/comet-contribution-graph@v1
        with:
          username: <user>

Embed in your profile README

![cinematic comet contribution graph](https://raw.githubusercontent.com/<user>/<user>/comet-graph/comet.svg)

Reduced-motion fallback

For users who prefer reduced motion, serve the static companion SVG via a <picture> element:

<picture>
  <source
    media="(prefers-reduced-motion: reduce)"
    srcset="
      https://raw.githubusercontent.com/<user>/<user>/comet-graph/comet-reduced.svg
    "
  />
  <img
    alt="cinematic comet contribution graph"
    src="https://raw.githubusercontent.com/<user>/<user>/comet-graph/comet.svg"
  />
</picture>

Inputs

name required default description
username yes GitHub login to render the graph for
token no ${{ github.token }} Token with contents:write on the target repo; for cross-repo use a classic PAT with repo scope or a fine-grained PAT with Contents: Read and write
reduced no "true" Also emit comet-reduced.svg for prefers-reduced-motion fallback
branch no "comet-graph" Output branch; force-pushed on every run

How it works

Every run fetches your GitHub contributions via the GraphQL API, passes them through a pure-TS SVG renderer (SMIL-animated comet tracing your most productive days across a constellation of your year), and force-pushes the result to an orphan branch in the repository where the workflow runs. Your profile README embeds the SVG via a stable raw.githubusercontent.com URL.

Concept

  • Preserves the familiar 7×53 contribution grid for legibility (weekday rows + month labels).
  • Every active day is a star; size and brightness scale with your own contribution volume, relative to your personal peak.
  • The top productive days are highlighted as golden spike stars.
  • A comet flies through them chronologically, leaving a glowing trail.
  • Inactive cells fade into a deep night sky; a soft layer of background stars adds atmosphere.

Contributing

This is a personal project, maintained solo. Feel free to open issues for bugs you hit, but please do not submit pull requests — I'm not accepting external contributions at this time.

License

Released under the MIT License. © 2026 Kristina Aquila.

About

A cinematic GitHub contribution graph — a comet traces your most productive days across a constellation of your year.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors