Skip to content
PingPongPlusPublic

About

A jet that shoots and destroys your GitHub commit history!

Topics

Resources

Contributing

Stars

12 stars

Watchers

0 watching

Forks

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

Git Jet

One to three pixel jets launch from a carrier, bank over your GitHub activity calendar, and destroy each active day's cell. Transparent background, rolling ocean swells, bow foam and a flowing stern wake, projectiles, pixel explosions and a spinning radar. Runs with GitHub Actions.

Lincoln — default carrier

A pixel jet launches from a Lincoln-inspired carrier through rolling ocean water, with an angled runway, detailed island and spinning radar.

Classic — original carrier with the green graph

The original ivory-island carrier with a spinning radar and flowing ocean wake launches a pixel jet to clear a green commit calendar.

Choose carrier: 'lincoln' (default) or carrier: 'classic' in your workflow. For the CLI, use --carrier classic. Both designs have the spinning radar.

Choose water: 'ocean' (default) for the flowing ocean surface and wake, or water: 'original' for the original small wave patches. This works with either carrier. For the CLI, use --water ocean or --water original.

Choose graph-theme: 'github' for GitHub green activity cells, as shown in the Classic demo. The default is graph-theme: 'blue', shown in the Lincoln demo. Either graph theme works with either carrier and water style. For the CLI, use --graph-theme github or --graph-theme blue.

Both demos show three jets and 101 synthetic contributions across 25 active days. Live mode uses your actual data. One attack clears one day cell, regardless of that day's count. The jet returns to land, the calendar rebuilds, and the animation loops.

Use in your profile

  1. Copy this workflow into your profile repository as .github/workflows/git-jet.yml.
  2. Open Actions → Git Jet → Run workflow. It publishes images to output.
  3. Add this to your README, replacing YOUR_USERNAME with your GitHub username:
<a href="https://github.com/PingPongPlus/git-jet">
  <picture>
    <source media="(prefers-reduced-motion: no-preference)"
      srcset="https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/git-jet.gif">
    <img width="960"
      src="https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/git-jet.png"
      alt="My GitHub activity cleared by a pixel jet">
  </picture>
</a>

Clicking the animation or its static fallback opens the Git Jet repository. Existing users can replace their image block with this snippet to add the link.

Updates run daily. Set days: '30', '7' or '365' under the generation step's with: section. The static PNG preserves the full calendar. Flight uses smooth curves at a steady cruise speed and fires while moving. The default is 20 FPS; fps: '10' makes smaller files while preserving flight speed. Set scale: '1' for smaller images.

GitHub contribution activity is counted by default. This includes the commits, issues, pull requests, reviews and other contributions that GitHub includes in its contribution calendar. Use activity: commits to select the previous public owned-repository commit mode. This setting works with either graph theme.

Set jets: '2' or jets: '3' to launch multiple jets and clear busy calendars faster. The default is jets: '1'. Jets share the day cells, so each active day is still attacked exactly once. Jets line up visibly on the runway, launch one at a time and land in order, returning to their original runway spots. Waiting jets remain visible before takeoff and after landing. Launch timing keeps the runway clear for each arrival. The calendar resets after every jet lands. Small calendars may take a similar time because launch and return flights still need to finish. For the CLI, use --jets 3.

GIFs over 25 MB are automatically retried at a lower resolution, then lower FPS if needed. Every day-cell attack is kept. To help keep your requested resolution, use more jets (jets: '3') to shorten the animation. Disable this fallback with auto-compress: 'false' or CLI --no-auto-compress.

Every generation picks a fresh route with varied sweeps, gentle bends and occasional small loops while shooting. To keep a favorite route, set seed: 'my-route' in the action or use CLI --seed my-route. Omit the seed for new randomness on each run. The generated report.json records the chosen seed.

Run locally

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e '.[dev]'
git-jet render --demo --output-dir out/demo
git-jet render --username YOUR_USERNAME --days 365 --carrier lincoln --output-dir out/live

For offline real-data rendering, use --calendar out/live/calendar.json. git-jet collect --username YOUR_USERNAME --output out/calendar.json saves data without rendering. Contribution activity requires GITHUB_TOKEN; Actions supplies its built-in token. Locally, set GITHUB_TOKEN to your GitHub token. Anonymous collection remains available with --activity commits. No server is needed.

Use --activity contributions (the default for live collection) or --activity commits with either render or collect. Cached calendars keep their recorded activity source; collect fresh data to switch sources.

What gets counted

activity: contributions (default): daily totals from GitHub's contributionsCollection.contributionCalendar. This follows GitHub's contribution rules, including qualifying activity in other people's repositories. It does not count every click, comment or push as a contribution. Private/internal contribution counts depend on profile visibility and the token's access. For private counts, provide your own token through token: ${{ secrets.GIT_JET_TOKEN }}; a classic personal access token needs the read:user scope. The built-in workflow token does not guarantee private contribution totals. Only daily counts are saved, without repository names or private activity details.

activity: commits: distinct authored commits in public, owned, non-fork repositories' default branches, including documentation commits. Duplicate SHAs count once. This mode excludes issues, PR activity, private repositories and unlinked author identities, so it can differ from GitHub's contribution calendar.

Both modes use a selected 1–365-day window including today in UTC. JSON calendars and reports distinguish contributions from commits; existing commit caches remain readable. Contribution caches use schema 2, total_contributions and per-day contributions; commit caches keep schema 1 and their existing commit fields.

Each active day gets one visible attack; flight length grows with active days. No targets are silently sampled or skipped. Empty calendars get a patrol with no shots. Export is bounded to 3,000 frames and 25 MB per GIF. If even the smallest render cannot fit, select fewer days. Failed generation preserves previously good assets.

Generation and publication are separate. The publisher updates only git-jet.gif and git-jet.png on output, preserves other files, uses non-force pushes and never changes your default branch. Publishing requires contents: write.

Goals

  • Approved carrier, parked aircraft, waves, directional jets, grid and effects.
  • GitHub contribution activity by default, optional authored-commit collection and daily Actions.
  • Catapult launch, banked flight, one attack per active day and carrier return.
  • Optional 1–3 jets to share targets and shorten busy calendars.
  • Optional one shot per individual commit mode.
  • More carrier/jet/runway designs and configurable graph palettes, with artwork approval.

Feel free to submit ideas by opening an issues I'm open to anything!

Artwork approvals · Contributing · MIT

About

A jet that shoots and destroys your GitHub commit history!

Topics

Resources

Contributing

Stars

12 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages