From e08bf6316b306d4e1288363966d522afaa045074 Mon Sep 17 00:00:00 2001 From: Tien Nguyen Minh Date: Sun, 19 Apr 2026 09:03:44 +0700 Subject: [PATCH] chore: drop tracked output/ sample in favor of CI-built demo gallery (#4) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The dracula sample under output/dracula/ was a reference render for the README. Now that demo/ auto-generates every card × every theme on each push, the sample is redundant — and keeping it trackers means every behavioral tweak shows up as a diff in committed SVGs. - Delete output/dracula/*.svg. - .gitignore: collapse `output/*` + `!output/dracula/` to a plain `output/`. - demo.yml: drop `output/**` from paths-ignore (no longer part of any push). - README / docs: point readers at demo/ instead of output/dracula/. --- .github/workflows/demo.yml | 1 - .gitignore | 7 +-- README.md | 7 ++- docs/codebase-summary.md | 4 +- docs/project-roadmap.md | 2 +- output/dracula/contributions-all-time.svg | 46 ---------------- output/dracula/contributions.svg | 48 ---------------- .../dracula/most-commit-language-all-time.svg | 19 ------- output/dracula/most-commit-language.svg | 19 ------- output/dracula/productive-time-all-time.svg | 55 ------------------- output/dracula/productive-time.svg | 49 ----------------- output/dracula/profile-details.svg | 16 ------ output/dracula/repos-per-language.svg | 19 ------- output/dracula/stats.svg | 25 --------- 14 files changed, 10 insertions(+), 307 deletions(-) delete mode 100644 output/dracula/contributions-all-time.svg delete mode 100644 output/dracula/contributions.svg delete mode 100644 output/dracula/most-commit-language-all-time.svg delete mode 100644 output/dracula/most-commit-language.svg delete mode 100644 output/dracula/productive-time-all-time.svg delete mode 100644 output/dracula/productive-time.svg delete mode 100644 output/dracula/profile-details.svg delete mode 100644 output/dracula/repos-per-language.svg delete mode 100644 output/dracula/stats.svg diff --git a/.github/workflows/demo.yml b/.github/workflows/demo.yml index 589dc6f3..976361e7 100644 --- a/.github/workflows/demo.yml +++ b/.github/workflows/demo.yml @@ -5,7 +5,6 @@ on: branches: [main] paths-ignore: - "demo/**" - - "output/**" - "**.md" - "LICENSE" workflow_dispatch: diff --git a/.gitignore b/.gitignore index 0f7a2d49..247f1a3e 100644 --- a/.gitignore +++ b/.gitignore @@ -27,10 +27,9 @@ go.work.sum # env file .env -# Generated SVG cards from local runs — keep the dracula sample tracked so the -# README's embedded previews resolve; other themes are rebuilt on demand. -output/* -!output/dracula/ +# Generated SVG cards from local runs. Use the demo/ gallery (auto-generated +# in CI) as the reference render instead of committing a sample here. +output/ # Editor/IDE # .idea/ diff --git a/README.md b/README.md index 597bb8cb..bf6bbf5c 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Cards rendered: | 13 | **Contributions (all time)** | Area chart across every active year, auto-thinned x-axis labels | | 14 | **Contributions by year** | One bar per active year, peak year highlighted | -Live `dracula` sample ships in [`output/dracula/`](./output/dracula). Every available theme rendered against the author's profile — profile details, stats, language donuts, productive-time, contributions — is browsable in the auto-generated [**demo gallery**](./demo). Regenerated on every push to `main` by [`.github/workflows/demo.yml`](./.github/workflows/demo.yml). +Every available theme rendered against the author's profile — profile details, stats, language donuts, productive-time, heatmap, streak, contributions, top repos — is browsable in the auto-generated [**demo gallery**](./demo). Regenerated on every push to `main` by [`.github/workflows/demo.yml`](./.github/workflows/demo.yml). ## In the wild @@ -187,8 +187,9 @@ output/ contributions-by-year.svg ``` -Only the `dracula` theme is tracked in git as a reference sample; other -themes are rebuilt on each run and gitignored. +`output/` is entirely gitignored — it's regenerated on each run. For a +reference render of every card in every theme, see the CI-built +[`demo/`](./demo) gallery instead. ## Tokens & permissions diff --git a/docs/codebase-summary.md b/docs/codebase-summary.md index e966f0e4..c3f75198 100644 --- a/docs/codebase-summary.md +++ b/docs/codebase-summary.md @@ -45,8 +45,8 @@ ghstats/ │ └── demo.yml # Renders every theme for the repo owner on push to main ├── docs/ # This directory ├── plans/ # Research reports + implementation plans -├── demo/ # Auto-generated gallery — every card × every theme + README -└── output/dracula/ # Sample committed; other themes gitignored +└── demo/ # Auto-generated gallery — every card × every theme + README + # (`output/` is entirely gitignored; see demo/ for reference renders) ``` ## Module responsibilities diff --git a/docs/project-roadmap.md b/docs/project-roadmap.md index 41c3dab4..be65a185 100644 --- a/docs/project-roadmap.md +++ b/docs/project-roadmap.md @@ -78,7 +78,7 @@ Card count: 9 → 14. `FetchProductive` still pays for commit-history pagination - New `.github/workflows/demo.yml` renders every card for every theme against the repo owner's profile on each push to `main`. - Output lands in `demo//`, with an auto-generated `demo/README.md` TOC so reviewers can browse palettes side-by-side with real data instead of cloning and running the CLI. -- Loop prevention: workflow skips pushes that only touch `demo/**`, `output/**`, `**.md`, or `LICENSE`; `GITHUB_TOKEN`-driven pushes don't retrigger workflows by design. +- Loop prevention: workflow skips pushes that only touch `demo/**`, `**.md`, or `LICENSE`; `GITHUB_TOKEN`-driven pushes don't retrigger workflows by design. - Consumer impact: none — this is a repo-internal discovery aid, not a shipped feature. --- diff --git a/output/dracula/contributions-all-time.svg b/output/dracula/contributions-all-time.svg deleted file mode 100644 index b7d31703..00000000 --- a/output/dracula/contributions-all-time.svg +++ /dev/null @@ -1,46 +0,0 @@ - - - Contributions (all time) - - - - 0 - - 0 - - 100 - - 100 - - 200 - - 200 - - 300 - - 300 - - 400 - - 400 - - 500 - - 500 - - - 01/18 - - 08/19 - - 03/21 - - 10/22 - - 05/24 - - 04/26 - - - mm/yy - \ No newline at end of file diff --git a/output/dracula/contributions.svg b/output/dracula/contributions.svg deleted file mode 100644 index 83dace33..00000000 --- a/output/dracula/contributions.svg +++ /dev/null @@ -1,48 +0,0 @@ - - - Contributions (last year) - - - - 0 - - 0 - - 100 - - 100 - - 200 - - 200 - - 300 - - 300 - - 400 - - 400 - - 500 - - 500 - - - 04/25 - - 06/25 - - 08/25 - - 10/25 - - 12/25 - - 02/26 - - 04/26 - - - mm/yy - \ No newline at end of file diff --git a/output/dracula/most-commit-language-all-time.svg b/output/dracula/most-commit-language-all-time.svg deleted file mode 100644 index e19204c1..00000000 --- a/output/dracula/most-commit-language-all-time.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - Most Commit Language (all time) - - JavaScript 32.66% - - HTML 20.34% - - Java 17.36% - - Go 5.54% - - Other 24.09% - - - - - - \ No newline at end of file diff --git a/output/dracula/most-commit-language.svg b/output/dracula/most-commit-language.svg deleted file mode 100644 index 7a0d5dd3..00000000 --- a/output/dracula/most-commit-language.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - Most Commit Language (last year) - - JavaScript 48.50% - - HTML 11.08% - - Go 9.87% - - Java 7.86% - - Other 22.69% - - - - - - \ No newline at end of file diff --git a/output/dracula/productive-time-all-time.svg b/output/dracula/productive-time-all-time.svg deleted file mode 100644 index 5fce4618..00000000 --- a/output/dracula/productive-time-all-time.svg +++ /dev/null @@ -1,55 +0,0 @@ - - - Commits by Hour (all time, UTC+7.00) - - - 0 - - 50 - - 100 - - 150 - - 200 - - 250 - - 300 - - - 0 - - 6 - - 12 - - 18 - - 23 - 00:00 — 144 commits - 01:00 — 56 commits - 02:00 — 12 commits - 03:00 — 11 commits - 04:00 — 9 commits - 05:00 — 7 commits - 06:00 — 7 commits - 07:00 — 7 commits - 08:00 — 41 commits - 09:00 — 92 commits - 10:00 — 142 commits - 11:00 — 164 commits - 12:00 — 125 commits - 13:00 — 119 commits - 14:00 — 124 commits - 15:00 — 76 commits - 16:00 — 89 commits - 17:00 — 96 commits - 18:00 — 102 commits - 19:00 — 87 commits - 20:00 — 228 commits - 21:00 — 314 commits - 22:00 — 272 commits - 23:00 — 244 commits - hour of day - \ No newline at end of file diff --git a/output/dracula/productive-time.svg b/output/dracula/productive-time.svg deleted file mode 100644 index 0ac8d94d..00000000 --- a/output/dracula/productive-time.svg +++ /dev/null @@ -1,49 +0,0 @@ - - - Commits by Hour (last year, UTC+7.00) - - - 0 - - 50 - - 100 - - 150 - - - 0 - - 6 - - 12 - - 18 - - 23 - 00:00 — 77 commits - 01:00 — 27 commits - 02:00 — 1 commits - 03:00 — 4 commits - 04:00 — 0 commits - 05:00 — 0 commits - 06:00 — 2 commits - 07:00 — 0 commits - 08:00 — 29 commits - 09:00 — 72 commits - 10:00 — 89 commits - 11:00 — 80 commits - 12:00 — 53 commits - 13:00 — 65 commits - 14:00 — 56 commits - 15:00 — 45 commits - 16:00 — 52 commits - 17:00 — 57 commits - 18:00 — 43 commits - 19:00 — 35 commits - 20:00 — 120 commits - 21:00 — 146 commits - 22:00 — 172 commits - 23:00 — 145 commits - hour of day - \ No newline at end of file diff --git a/output/dracula/profile-details.svg b/output/dracula/profile-details.svg deleted file mode 100644 index e4ec1b21..00000000 --- a/output/dracula/profile-details.svg +++ /dev/null @@ -1,16 +0,0 @@ - - - tiennm99 (Tien Nguyen Minh) - - VNG Corporation - - Ho Chi Minh - Viet Nam - - miti99.com - - 2018-05-07 (7 years ago) - - 10 followers · 14 following - - 145 public repos - \ No newline at end of file diff --git a/output/dracula/repos-per-language.svg b/output/dracula/repos-per-language.svg deleted file mode 100644 index eacae3ce..00000000 --- a/output/dracula/repos-per-language.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - Repos Per Language - - JavaScript 20.00% - - Java 16.92% - - Go 14.62% - - Python 10.00% - - Other 38.46% - - - - - - \ No newline at end of file diff --git a/output/dracula/stats.svg b/output/dracula/stats.svg deleted file mode 100644 index 80350155..00000000 --- a/output/dracula/stats.svg +++ /dev/null @@ -1,25 +0,0 @@ - - - Stats - - Total Stars - 4 - - Total Commits (all time) - 3,121 - - Total Commits (last year) - 1,749 - - Total PRs - 69 - - Total Issues - 7 - - Total PR Reviews - 0 - - Contributed to - 15 - \ No newline at end of file