GRS Action 🎉🎉 #2537

Zo-Bro-23 · 2023-02-22T12:53:45Z

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 · 2023-02-22T12:53:50Z

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 · 2023-02-22T12:56:11Z

Codecov Report

Base: 97.27% // Head: 97.27% // No change to project coverage 👍

Coverage data is based on head (33ad0f4) compared to base (ba7c2f8).
Patch has no changes to coverable lines.

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

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

rickstaa · 2023-02-22T18:35:18Z

readme.md

+- `options` - `REQUIRED` - Any customization options. More below. (This is the same as the query string you would pass to the API if using the community deployment)
+- `card` - The type of card to generate. `repo`, `top-langs`, or `wakatime` (leave empty for stats card).
+- `path` - Output path for SVG file. Relative path; include filename with `.svg`.
+- `fetch_multipage` - Experimental feature that gives more accurate stats if you have >100 repos.


As discussed on discord, this can be removed and enabled by default.

Yes, I will implement that.

Cool thanks! People can still disable it by changing the environment variable. This variable has to be documented in the GRS readme. We can do that later.

rickstaa · 2023-02-22T18:35:48Z

readme.md

@@ -115,7 +242,7 @@ You can pass a query parameter `&hide=` to hide any specific stats with comma-se
 > Options: `&hide=stars,commits,prs,issues,contribs`

 ```md
-![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)
+?username=anuraghazra&hide=contribs,prs


Why did you remove the full markdown code? 🤔

When using the GitHub action, you don't give options through the URL. Instead you give the ?param=something&... options as an input for the action. Having the markdown code will make it confusing for those using the action. Instead, I've included instructions at the top on how to customize the card for the action version and the hosted version, and I'm just mentioning the custom options below. This also makes the documentation cleaner in my opinion. No need to keep repeating the markdown code if it's already specified at the top.

I already suspected that. I prefer having the full card generation code in GRS and a note in the GitHub action about this. I am afraid many beginners or lazy people will create new issues and discussions. We can document the difference in the action README. If you want, you can even add a warning/Note to make it more clear:

Warning
This is a warning.

> **Warning** > This is a warning.

Note
This is a warning.

> **Note** > This is a warning.

Anyway, if @anuraghazra thinks your change is fine, I'm also okay with it. 👍🏻

rickstaa · 2023-02-22T18:36:10Z

readme.md

@@ -199,8 +326,8 @@ You can use the `bg_color` parameter to make any of [the available themes](./the
 You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) tags to switch the theme based on the user GitHub theme automatically. This is done by appending `#gh-dark-mode-only` or `#gh-light-mode-only` to the end of an image URL. This tag will define whether the image specified in the markdown is only shown to viewers using a light or a dark GitHub theme:

 ```md
-[![Anurag's GitHub stats-Dark](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)
-[![Anurag's GitHub stats-Light](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=default#gh-light-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)
+[![Anurag's GitHub stats-Dark](https://DARK_SVG_URL/#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)


I think this is temporary right?

Because the file path is an input, the filename can be whatever the user chooses. Moreover, we directly do not push to any branch. Depending on which action they use to push, the raw url of the svg may be different. Finally, GitHub raw usercontent is blocked by Jio, which is one of the largest ISPs in India. This means that many, me included, can't view GitHub raw files. Initially I built my own proxy, but now I just use GitHub Pages. Either one will change the url. I've included instructions on how to find this URL above, and they just have to replace SVG_URL in the sample code with that url.

I see. I think I agree with you on this point. If we clearly describe the <DARK_SVG_URL> and <SVG_URL> above it should be fine.

BTW if you would love to make the documentation more clear, I think you will love the PR I and @mezzode did in #2242.

readme.md

rickstaa

See comments.

Zo-Bro-23 · 2023-02-23T02:37:07Z

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 · 2023-02-23T07:35:38Z

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 · 2023-02-23T07:55:21Z

good stuff

rickstaa · 2023-02-23T08:01:14Z

good stuff

Yeah right! I have been suggesting this since #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 · 2023-02-23T08:23:09Z

@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 #2473, merge #2537 and release the action 🚀.

ofek · 2023-03-27T17:12:46Z

Can the action be used now?

Zo-Bro-23 · 2023-03-28T06:06:18Z

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 · 2024-07-18T23:09:23Z

@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! =]

Zo-Bro-23 added 2 commits February 22, 2023 13:22

Documentation update 1

26a8a23

Documentation update 2

33ad0f4

Zo-Bro-23 assigned rickstaa Feb 22, 2023

Zo-Bro-23 added enhancement New feature or request. high-priority High priority issue or PR. labels Feb 22, 2023

Zo-Bro-23 linked an issue Feb 22, 2023 that may be closed by this pull request

Create GRS action #2179

Open

3 tasks

Zo-Bro-23 mentioned this pull request Feb 22, 2023

Create GRS action #2179

Open

3 tasks

rickstaa reviewed Feb 22, 2023

View reviewed changes

readme.md Show resolved Hide resolved

rickstaa requested changes Feb 22, 2023

View reviewed changes

rickstaa removed their assignment Mar 5, 2023

Zo-Bro-23 mentioned this pull request Mar 21, 2023

Stats number update #2583

Closed

YanbingJiang mentioned this pull request Aug 19, 2023

Stats failing to load on the first run #2603

Open

neverbot mentioned this pull request Sep 6, 2023

GRS as an npm module! #2473

Draft

rickstaa mentioned this pull request Dec 15, 2023

Migrate codebase to Typescript #2052

Open

This was referenced Jul 18, 2024

Deployment paused by owner #3854

Closed

Public deployment paused #3851

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GRS Action 🎉🎉 #2537

GRS Action 🎉🎉 #2537

Zo-Bro-23 commented Feb 22, 2023

vercel bot commented Feb 22, 2023

codecov bot commented Feb 22, 2023

rickstaa Feb 22, 2023

Zo-Bro-23 Feb 23, 2023

rickstaa Feb 23, 2023

rickstaa Feb 22, 2023

Zo-Bro-23 Feb 23, 2023

rickstaa Feb 23, 2023 •

edited

Loading

rickstaa Feb 22, 2023

Zo-Bro-23 Feb 23, 2023

rickstaa Feb 23, 2023

rickstaa left a comment

Zo-Bro-23 commented Feb 23, 2023

rickstaa commented Feb 23, 2023 •

edited

Loading

bunningss commented Feb 23, 2023

rickstaa commented Feb 23, 2023 •

edited

Loading

rickstaa commented Feb 23, 2023

ofek commented Mar 27, 2023

Zo-Bro-23 commented Mar 28, 2023

justinvforvendetta commented Jul 18, 2024 •

edited

Loading

GRS Action 🎉🎉 #2537

Are you sure you want to change the base?

GRS Action 🎉🎉 #2537

Conversation

Zo-Bro-23 commented Feb 22, 2023

vercel bot commented Feb 22, 2023

codecov bot commented Feb 22, 2023

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rickstaa Feb 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rickstaa left a comment

Choose a reason for hiding this comment

Zo-Bro-23 commented Feb 23, 2023

rickstaa commented Feb 23, 2023 • edited Loading

bunningss commented Feb 23, 2023

rickstaa commented Feb 23, 2023 • edited Loading

rickstaa commented Feb 23, 2023

ofek commented Mar 27, 2023

Zo-Bro-23 commented Mar 28, 2023

justinvforvendetta commented Jul 18, 2024 • edited Loading

rickstaa Feb 23, 2023 •

edited

Loading

rickstaa commented Feb 23, 2023 •

edited

Loading

rickstaa commented Feb 23, 2023 •

edited

Loading

justinvforvendetta commented Jul 18, 2024 •

edited

Loading