contribapi/README.md

1.2 KiB

contribapi

tiny extensible api to merge contribution heatmap from forgejo (git.gay, codeberg, etc) and github.

usage

this runs as a cloudflare worker

configuration

for testing, put these variables in .dev.vars. in production you will need to use wrangler to update worker secrets with this command:

pnpx wrangler secret put <name>
# it will prompt you for value

1. codeberg

codeberg (or forgejo in general) do not need api keys to get user heatmap.

CODEBERG_USERNAME=doughmination

2. github

github needs an api key. i recommend you use a fine grained personal access token with access to commit statuses of all repos.

https://github.com/settings/personal-access-tokens

GITHUB_USERNAME=doughmination
GITHUB_TOKEN=github_pat_xxxxxxxxxx

other forgejo instances

ill use git.gay in this example

  • copy src/forgejo.example.ts to, src/gitdotgay.ts
  • read comments in src/gitdotgay.ts and change as described, its like 4 changes
  • read queryForges function in src/index.ts and add your query function as shown

to remove github/etc, its the same, you just remove queryGithub

deploying

pnpm deploy