GRS Action 🎉🎉

[Zo-Bro-23]

The GRS GitHub Action is finally ready (I think)! This PR only updates the documentation, since the action is hosted here. This is necessary because GitHub requires (it's possible to get over this, but they don't recommend it) marketplace actions to have their own repo (see this).

Currently published in the GitHub Marketplace. Use Zo-Bro-23/grs-action@v0 for testing.

Some questions I have:

• [ ] Will there be problems when I migrate the action repo from my personal account to the GRS org? @rickstaa doesn't think so, so I'll perform some tests with him and update this comment accordingly.
• [ ] Should I remove the fetch_multipage option and just enable it by default? @rickstaa thinks so.
• [ ] The action currently uses card types stats, repo, top-langs, and wakatime. repo conflicts with the pin used for the API and stats conflicts with / used for the API, although an empty card type defaults to stats, which makes it compatible with the API. Is it worth renaming repo to pin to maintain backwards compatibility? repo seems more intuitive.
• [ ] Should I copy the docs to the marketplace entry or should I just link to this repo?
• [ ] Should the GitHub token be required (as is currently)? Technically wakatime can be used with a GH Token, but since it's easy to pass tokens in a workflow (secrets.GITHUB_TOKEN), is it fine leaving it as is? Will help save a lot of error handling code.
• [ ] Should I be worried about people messing up the file path? Technically they can write to non-SVG files and random paths. If the path is not allowed, then GitHub itself will give a permission denied error.
• [ ] Currently if you try to generate multiple cards (lang card, stat card, etc), the action might mess up since the push workflow I've included in the example rewrites the branch each time. So only one of the cards will be there finally. Instead, the example workflow uploads as artifacts and downloads to push. This still takes only a few seconds because of the small size of the SVG files, but will this be confusing for someone who tries to write their own workflow? Using a different push action like stefanzweifel/git-auto-commit-action will solve this, but that will make pushing and GH Pages deployment slower. Ultimately, the question is about which one I should include in the example workflow, since users are free to use whichever one they want.

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
github-readme-stats	✅ Ready (Inspect)	Visit Preview	Feb 22, 2023 at 0:53AM (UTC)

[codecov[bot]]

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 97.27%. Comparing base (ba7c2f8) to head (33ad0f4). :warning: Report is 917 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2537   +/-   ##
=======================================
  Coverage   97.27%   97.27%           
=======================================
  Files          24       24           
  Lines        4178     4178           
  Branches      384      384           
=======================================
  Hits         4064     4064           
  Misses        112      112           
  Partials        2        2           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

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

[Zo-Bro-23]

See comments.

Thank you for your comments. I've replied to them. Could you also please answer the questions I posted with my initial comment? Some of them have been answered by your review comments (you can ignore them), but others persist. Thanks!

[rickstaa]

Thank you for your comments. I've replied to them. Could you also please answer the questions I posted with my initial comment? Some of them have been answered by your review comments (you can ignore them), but others persist. Thanks!

Of course! I just answered them! You can mark them as resolved if you want. Let me know if you have any other questions.

[bunningss]

good stuff

[rickstaa]

good stuff

Yeah right! I have been suggesting this since https://github.com/anuraghazra/github-readme-stats/issues/2179. I am thrilled and thankful that @Zo-Bro-23 completed #2179🙏🏻. It will make the cards faster and more accurate and remove downtime.

[rickstaa]

@Zo-Bro-23 I finished all my tests and left the comments on the GRS action repo. 👍🏻 It even works with dynamic themes (see https://github.com/rickstaa/rickstaa/actions/runs/4250642780). @anuraghazra I think we can migrate to an organization structure; review https://github.com/anuraghazra/github-readme-stats/pull/2473, merge #2537 and release the action 🚀.

[ofek]

Can the action be used now?

[Zo-Bro-23]

Can the action be used now?

It can be used, but I'm working on writing the proper documentation and creating the required tests. I would not recommend using it until #2473 is merged.

[justinvforvendetta]

@Zo-Bro-23 shouldnt you add documentation to the grs repository README directly as well? (https://github.com/Zo-Bro-23/grs-action) when/if people find it thru the marketplace, there is no documentation for it there, other than the title. just my advice. also, great work! =]

[filipopo]

Is this alive?