Skip to content

About

A remotion GitHub action for generating readme profile gifs of your GitHub stats

Topics

Resources

Stars

9 stars

Watchers

1 watching

Forks

Repository files navigation

GitHub Stats Remotion

Remotion profile graphics for the public stats JSON generated by stats-action. The workflow renders animated WebP assets plus GIF fallbacks and publishes them to GitHub Pages, so generated images do not grow the source repository history.

Live Assets

Use the Pages URLs from this repository in a profile README:

<picture>
  <source srcset="https://lukasparke.github.io/github-stats-remotion/readme.webp" type="image/webp" />
  <img src="https://lukasparke.github.io/github-stats-remotion/readme.gif" alt="LukasParke GitHub stats" />
</picture>

Available assets:

  • readme.webp / readme.gif
  • main-stats.webp / main-stats.gif
  • stats.webp / stats.gif
  • repo-impact.webp / repo-impact.gif
  • languages.webp / languages.gif
  • top-languages.webp / top-languages.gif
  • activity-overview.webp / activity-overview.gif
  • commit-streak.webp / commit-streak.gif
  • issue-tracking.webp / issue-tracking.gif
  • code-metrics.webp / code-metrics.gif

Data Source

The default input is:

{
  "username": "LukasParke",
  "statsUrl": "https://raw.githubusercontent.com/LukasParke/stats/main/github-user-stats.json"
}

For a template fork, change input.json and the workflow stats-json-url default to your public stats repository.

The renderer supports both the new schemaVersion: 2 stats output and the old legacy JSON shape. It refuses to render public assets when the stats JSON contains private repository details unless ALLOW_PRIVATE_REPOSITORY_DETAILS is explicitly set to true.

Local Rendering

yarn install --frozen-lockfile
yarn prepare:stats
yarn render:all

Rendered assets are written to pages/, which is intentionally ignored by Git.

CI Publishing

.github/workflows/render-video.yml renders on pushes, daily schedule, and manual dispatch. It publishes pages/ with GitHub Pages instead of committing generated images back to main.

About

A remotion GitHub action for generating readme profile gifs of your GitHub stats

Topics

Resources

Stars

9 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages