docs: add github action as recommended usage method by rickstaa · Pull Request #4716 · anuraghazra/github-readme-stats

rickstaa · 2025-12-27T09:26:15Z

Add new github action as recommended usage method now that we are no longer sponsored by vercel and the hosted endpoint is not available anymore.

Add new github action as recommended usage method now that we are no longer sponsored by vercel and the hosted endpoint is not available anymore. Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com>

vercel · 2025-12-27T09:26:19Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
github-readme-stats	Ready	Preview	Dec 27, 2025 6:34pm

codecov · 2025-12-27T09:26:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.80%. Comparing base (453f77f) to head (e254e07).
⚠️ Report is 17 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4716   +/-   ##
=======================================
  Coverage   96.80%   96.80%           
=======================================
  Files          36       36           
  Lines        7316     7316           
  Branches      608      608           
=======================================
  Hits         7082     7082           
  Misses        225      225           
  Partials        9        9

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

rickstaa · 2025-12-27T17:40:34Z

@qwerty541 let's put this in draft. As pointed out by @jfullstackdev in this comment we should ensure people know that both the action and the self deploymnet are now the recommended methods. I will update my pr.

* docs: add github action as recommended usage method (#3) Add new github action as recommended usage method now that we are no longer sponsored by vercel and the hosted endpoint is not available anymore. Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com> * docs: ensure example cards render correctly (#4) Use my deployed environment so example cards render properly and are not rate-limited by the public instance. * fix docs links, prepare workflows, update action example * fix formatting * docs(theme): auto update theme readme (#5) Co-authored-by: GitHub Readme Stats Bot <no-reply@githubreadmestats.com> * ci(deps): Bump stefanzweifel/git-auto-commit-action from 7.0.0 to 7.1.0 (#6) Bumps [stefanzweifel/git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) from 7.0.0 to 7.1.0. - [Release notes](https://github.com/stefanzweifel/git-auto-commit-action/releases) - [Changelog](https://github.com/stefanzweifel/git-auto-commit-action/blob/master/CHANGELOG.md) - [Commits](stefanzweifel/git-auto-commit-action@28e16e8...04702ed) --- updated-dependencies: - dependency-name: stefanzweifel/git-auto-commit-action dependency-version: 7.1.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ci(deps): Bump actions/setup-node from 6.1.0 to 6.2.0 (#7) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 6.1.0 to 6.2.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@395ad32...6044e13) --- updated-dependencies: - dependency-name: actions/setup-node dependency-version: 6.2.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): Bump prettier from 3.7.4 to 3.8.0 (#13) Bumps [prettier](https://github.com/prettier/prettier) from 3.7.4 to 3.8.0. - [Release notes](https://github.com/prettier/prettier/releases) - [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md) - [Commits](prettier/prettier@3.7.4...3.8.0) --- updated-dependencies: - dependency-name: prettier dependency-version: 3.8.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): Bump eslint-plugin-jsdoc from 61.5.0 to 62.0.1 (#12) Bumps [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) from 61.5.0 to 62.0.1. - [Release notes](https://github.com/gajus/eslint-plugin-jsdoc/releases) - [Commits](gajus/eslint-plugin-jsdoc@v61.5.0...v62.0.1) --- updated-dependencies: - dependency-name: eslint-plugin-jsdoc dependency-version: 62.0.1 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): Bump globals from 16.5.0 to 17.0.0 (#9) Bumps [globals](https://github.com/sindresorhus/globals) from 16.5.0 to 17.0.0. - [Release notes](https://github.com/sindresorhus/globals/releases) - [Commits](sindresorhus/globals@v16.5.0...v17.0.0) --- updated-dependencies: - dependency-name: globals dependency-version: 17.0.0 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * docs: add github action as recommended usage method (anuraghazra#4716) * docs: add github action as recommended usage method Add new github action as recommended usage method now that we are no longer sponsored by vercel and the hosted endpoint is not available anymore. Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com> * docs: improve action section --------- Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com> * docs: add instructions to make PAT environment variable sensitive in Vercel deployment (#14) Added instructions for setting environment variables securely. Signed-off-by: Joey Chen <142381267+JoeyC-Dev@users.noreply.github.com> * Fix default theme fallback when an invalid theme is passed (#15) * fix(color): invalid theme fallback to default Fixes: anuraghazra#4641 * test(color): add test case for invalid theme fallback to default * style(color): add back the tab space * test(color): fix color default theme * fix(color): use 'in' instead of '.hasOwnProperty' * fix new test * format code --------- Co-authored-by: mikyll <righi.michy@gmail.com> * fix tests, add CI, fix on mac, extend docs (#25) * tests: fix float problems and PAT problem * extend CONTRIBUTING.md * extend build documentation, add GH action, fix build on MacOS * fix build on Vercel * update .gitignore and CONTRIBUTING.md * fix all tests * add backend tests to CI * make e2e tests work * add debug log to e2e test * ignore copied tests in CI * feature(top langs card): add ability to change progress bar background color in normal layout (#16) * anuraghazra#3307 enhancement : prog_bg_color query added to change the background of progress bar * anuraghazra#3066 bug Fixed : readme.md file as stated * anuraghazra#3066 bug Fixed : readme.md file as stated" * anuraghazra#3066 bug Fixed : readme.md file as stated * fix types.d.ts * add test --------- Co-authored-by: krishnoit <krishnoit100@gmail.com> Co-authored-by: krishna seth <75961965+a-s-t-e-y-a@users.noreply.github.com> * allow triggering workflows manually (#17) * refactor: update languages JSON (#18) Co-authored-by: martin-mfg <2026226+martin-mfg@users.noreply.github.com> * remove remaining barrel files * ci(deps): Bump actions/checkout from 6.0.1 to 6.0.2 (#19) Bumps [actions/checkout](https://github.com/actions/checkout) from 6.0.1 to 6.0.2. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@8e8c483...de0fac2) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: 6.0.2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): Bump prettier from 3.8.0 to 3.8.1 (#22) Bumps [prettier](https://github.com/prettier/prettier) from 3.8.0 to 3.8.1. - [Release notes](https://github.com/prettier/prettier/releases) - [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md) - [Commits](prettier/prettier@3.8.0...3.8.1) --- updated-dependencies: - dependency-name: prettier dependency-version: 3.8.1 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): Bump globals from 17.0.0 to 17.1.0 (#23) Bumps [globals](https://github.com/sindresorhus/globals) from 17.0.0 to 17.1.0. - [Release notes](https://github.com/sindresorhus/globals/releases) - [Commits](sindresorhus/globals@v17.0.0...v17.1.0) --- updated-dependencies: - dependency-name: globals dependency-version: 17.1.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * ci(deps): Bump peter-evans/create-pull-request from 8.0.0 to 8.1.0 (#21) Bumps [peter-evans/create-pull-request](https://github.com/peter-evans/create-pull-request) from 8.0.0 to 8.1.0. - [Release notes](https://github.com/peter-evans/create-pull-request/releases) - [Commits](peter-evans/create-pull-request@98357b1...c0f553f) --- updated-dependencies: - dependency-name: peter-evans/create-pull-request dependency-version: 8.1.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build(deps-dev): Bump eslint-plugin-jsdoc from 62.0.1 to 62.4.0 (#20) Bumps [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) from 62.0.1 to 62.4.0. - [Release notes](https://github.com/gajus/eslint-plugin-jsdoc/releases) - [Commits](gajus/eslint-plugin-jsdoc@v62.0.1...v62.4.0) --- updated-dependencies: - dependency-name: eslint-plugin-jsdoc dependency-version: 62.4.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "remove remaining barrel files" This reverts commit 31df917. * fix formatting --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Joey Chen <142381267+JoeyC-Dev@users.noreply.github.com> Co-authored-by: Rick Staa <rick.staa@outlook.com> Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com> Co-authored-by: GitHub Readme Stats Bot <no-reply@githubreadmestats.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joey Chen <142381267+JoeyC-Dev@users.noreply.github.com> Co-authored-by: mikyll <righi.michy@gmail.com> Co-authored-by: krishnoit <krishnoit100@gmail.com> Co-authored-by: krishna seth <75961965+a-s-t-e-y-a@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

docs: add github action as recommended usage method (anuraghazra#4716)

* docs: add github action as recommended usage method Add new github action as recommended usage method now that we are no longer sponsored by vercel and the hosted endpoint is not available anymore. Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com> * docs: improve action section --------- Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com>

#77) * docs: add github action as recommended usage method Add new github action as recommended usage method now that we are no longer sponsored by vercel and the hosted endpoint is not available anymore. * docs: improve action section --------- Co-authored-by: Rick Staa <rick.staa@outlook.com> Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com>

* docs: add github action as recommended usage method Add new github action as recommended usage method now that we are no longer sponsored by vercel and the hosted endpoint is not available anymore. Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com> * docs: improve action section --------- Co-authored-by: Ulysses Zhan <UlyssesZhan@gmail.com> Co-authored-by: Zohan Subhash <zohan.subhash@gmail.com> Co-authored-by: Alexandr <qwerty541zxc@gmail.com>

github-actions Bot added the documentation Improvements or additions to documentation. label Dec 27, 2025

rickstaa requested a review from qwerty541 December 27, 2025 09:26

This was referenced Dec 27, 2025

GRS Action 🎉🎉 #2537

Closed

Instructions about using GitHub Actions to generate cards #4268

Closed

Create GRS action #2179

Open

Replace broken images in README #4671

Open

rickstaa marked this pull request as draft December 27, 2025 17:40

docs: improve action section

53a6cda

vercel Bot deployed to Preview December 27, 2025 18:34 View deployment

rickstaa marked this pull request as ready for review December 27, 2025 18:35

rickstaa requested a review from anuraghazra January 1, 2026 09:22

martin-mfg mentioned this pull request Jan 2, 2026

Provide GitHub Actions deployment guideline. #4723

Closed

anuraghazra approved these changes Jan 18, 2026

View reviewed changes

anuraghazra merged commit 5df91f9 into master Jan 18, 2026
8 checks passed

Mazdaratti added a commit to Mazdaratti/github-readme-stats that referenced this pull request Jan 27, 2026

Merge pull request #10 from anuraghazra/master

dd71217

docs: add github action as recommended usage method (anuraghazra#4716)

saqirana pushed a commit to saqirana/github-readme-stats that referenced this pull request Apr 20, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

d503765

Lucifer4255 pushed a commit to Lucifer4255/github-readme-stats that referenced this pull request May 5, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

4afe161

N-Pacis pushed a commit to N-Pacis/github-readme-stats that referenced this pull request May 12, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

e648415

Git-by-Muhammad pushed a commit to Git-by-Muhammad/github-readme-stats that referenced this pull request May 17, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

46a705c

Ahsankhalid618 pushed a commit to Ahsankhalid618/github-readme-stats that referenced this pull request May 18, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

1fcc976

todinhvan pushed a commit to todinhvan/github-readme-stats that referenced this pull request May 24, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

c7534a2

noelams pushed a commit to noelams/github-readme-stats that referenced this pull request Jun 14, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

bc58898

Ahsankhalid618 pushed a commit to Ahsankhalid618/github-readme-stats that referenced this pull request Jul 5, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

80f0c7a

Git-by-Muhammad pushed a commit to Git-by-Muhammad/github-readme-stats that referenced this pull request Jul 5, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

7aaf22b

kaosi-anikwe pushed a commit to kaosi-anikwe/github-readme-stats that referenced this pull request Jul 13, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

c4dad6e

todinhvan pushed a commit to todinhvan/github-readme-stats that referenced this pull request Jul 15, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

aa4516e

N-Pacis pushed a commit to N-Pacis/github-readme-stats that referenced this pull request Jul 19, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

87b74cb

noelams pushed a commit to noelams/github-readme-stats that referenced this pull request Jul 20, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

584f524

Git-by-Muhammad pushed a commit to Git-by-Muhammad/github-readme-stats that referenced this pull request Aug 3, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

3469456

todinhvan pushed a commit to todinhvan/github-readme-stats that referenced this pull request Aug 6, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

6c676cb

Ahsankhalid618 pushed a commit to Ahsankhalid618/github-readme-stats that referenced this pull request Aug 6, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

186f8a7

Ahsankhalid618 pushed a commit to Ahsankhalid618/github-readme-stats that referenced this pull request Aug 7, 2026

docs: add github action as recommended usage method (anuraghazra#4716)

5d65c1e

Navigation Menu

Uh oh!

docs: add github action as recommended usage method - #4716

docs: add github action as recommended usage method#4716
anuraghazra merged 2 commits into
masterfrom
docs/add-github-action

rickstaa commented Dec 27, 2025

Uh oh!

vercel Bot commented Dec 27, 2025 •

edited

Loading

Uh oh!

codecov Bot commented Dec 27, 2025

Uh oh!

rickstaa commented Dec 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

rickstaa commented Dec 27, 2025

Uh oh!

vercel Bot commented Dec 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Dec 27, 2025

Codecov Report

Uh oh!

rickstaa commented Dec 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vercel Bot commented Dec 27, 2025 •

edited

Loading