Providers

GitHub

Setting up Profile Graphics with the GitHub API.

Token permissions

For public stats the default GITHUB_TOKEN is enough — it is automatically available in GitHub Actions.

To include private repository data (include_private: true), create a Personal Access Token (PAT) with the following scopes:

repo read:user

Store the PAT as a repository secret: Settings → Secrets → Actions → New repository secret. Name it e.g. GH_TOKEN.

Config example

profile-graphics.yml

provider:
  type: github
  user: your-username
  token: ${GH_TOKEN}
  include_private: true

.github/workflows/stats.yml — with PAT

- uses: mikhailkhorokhorin/profile-graphics@v1
  with:
    username: ${{ github.actor }}
    token: ${{ secrets.GH_TOKEN }}
    include_private: "true"

Rate limits

GitHub GraphQL API: 5000 points/hour. Generating all 8 charts uses ~3 requests. Running on a 6-hour schedule will not exhaust the limit.

Troubleshooting

Resource not accessible by integration — the token lacks required permissions. Make sure the workflow has permissions: contents: write or use a PAT.

Could not resolve to a User — incorrect username. Check the spelling (case-sensitive).