Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.09 KB

README.md

File metadata and controls

35 lines (26 loc) · 1.09 KB

grs-action

A GitHub Action to generate GitHub Readme Stats.

Example usage:

- name: Generate Stats
  uses: UlyssesZh/grs-action@v0
  with:
    card: stats
    options: username=${{ github.repository_owner }}&hide_border=true
    path: grs/stats.svg

For an example of the generated card, see here.

For a more complicated example, see my own profile.

Inputs

  • card: The type of card to generate. Can be stats (default), repo, langs, wakatime, or gist.
  • options: The options to pass to the card. For example, username=UlyssesZh&hide_border=true. Defaults to username=${{github.repository_owner}}.
  • path: The path to save the generated card to. Defaults to grs/out.svg.
  • token: The GitHub token to use for fetching data. Normally no need to set this.

Environment variables:

  • FETCH_MULTI_PAGE_STARS: experimental multi-page fetching.