feat: add clickable GitHub profile links to contributors - #218
Conversation
d954449 to
f37a147
Compare
|
Thank you! I've updated the PR to work similar to the suggested design. There's one part to note, which is that due to the usage of a partial index, there's a hardcoded schema constant ( It's been a fair while since I've worked with Postgres, so I might be wrong, but it might be potentially resource intensive to not use a partial index here due to it being unindexed JSON data. Copilot did have the following suggestion, but I felt I'd stick with what I was familiar with for now:
Please let me know if you're happy with the current setup, or would prefer an alternative (either the Copilot suggestion or another) :) |


Description
This PR adds GitHub profile links for contributors to each version, allowing better attribution, as well as consistency for people who accidentally commit under multiple emails. It's done transparently, so any commits that do not have this data will fallback to the old system, making this non-breaking.
The only caveat here is that it does add requests to the GitHub API. For rate limit purposes, I've allow an optional GitHub token to be supplied to benefit from higher limits, however it'll work fine by default with the lower limits. If it fails, it'll just not store the data. Main goal with this is to keep it non-breaking, and never let these additional requests hold back a build, eg during a GitHub outage.
Type of Change
feat: New feature (non-breaking change which adds functionality)fix: Bug fix (non-breaking change which fixes an issue)docs: Documentation updaterefactor: Code refactoring (no functional changes)perf: Performance improvementtest: Adding or updating testschore: Maintenance tasks (dependencies, tooling, etc.)ci: CI/CD configuration changesTesting
go test ./...go generate ./...)Commit Message Format
Checklist
go generate ./...to update generated code