Docs
GitHub Projects
Standalone repository sync, auto-imports, and GitHub Project badge endpoints.
What the module does
- Create a standalone GitHub Project record without pretending the repository is a Minecraft plugin.
- Queue manual syncs or schedule auto-sync against
GithubRepoService. - Publish public project pages plus dedicated shields at
/shields/github-projects/{project}/{metric}.png. - Keep existing plugin-linked GitHub sync intact while you migrate only the repositories that need a standalone home.
Badges
GitHub Project badge / shield endpoints
Use these PNG badge endpoints anywhere you need live repository stats. The metric keys below are loaded from GithubProjectShieldService::supportedMetrics() so the docs stay aligned with the service implementation.
GET https://ezbanners.org/shields/github-projects/YOUR-UUID/{metric}.png
Base pattern
GET https://ezbanners.org/shields/github-projects/YOUR-UUID/{metric}.png?label=release&color=0969da&style=flat-square
Optional query parameters: label, color, and style
| Metric key | Endpoint | What it shows |
|---|---|---|
stars |
/shields/github-projects/{uuid}/stars.png |
Shows the synced GitHub stargazer count. |
forks |
/shields/github-projects/{uuid}/forks.png |
Shows the synced fork count. |
watchers |
/shields/github-projects/{uuid}/watchers.png |
Shows the synced watcher count. |
latest-release |
/shields/github-projects/{uuid}/latest-release.png |
Shows the latest synced release tag or N/A. |
issues-open |
/shields/github-projects/{uuid}/issues-open.png |
Counts currently open GitHub issues from the synced payload. |
repo |
/shields/github-projects/{uuid}/repo.png |
Displays the configured owner/repository slug. |
status |
/shields/github-projects/{uuid}/status.png |
Reflects whether the standalone project is actively syncing. |
Supported query parameters
labeloverrides the left-hand badge text. Example:?label=repo%20health.coloroverrides the metric color with a hex value like0969daor4c1.stylechanges the shield style. Supported values follow the shared shield renderer:flat,flat-square,plastic, andfor-the-badge.
Copyable embed examples
Repository
Markdown

BBCode
[IMG]https://ezbanners.org/shields/github-projects/YOUR-UUID/repo.png[/IMG]
HTML
<img src="https://ezbanners.org/shields/github-projects/YOUR-UUID/repo.png" alt="Repository badge" />
GitHub Stars
Markdown

BBCode
[IMG]https://ezbanners.org/shields/github-projects/YOUR-UUID/stars.png[/IMG]
HTML
<img src="https://ezbanners.org/shields/github-projects/YOUR-UUID/stars.png" alt="GitHub Stars badge" />
Latest Release
Markdown

BBCode
[IMG]https://ezbanners.org/shields/github-projects/YOUR-UUID/latest-release.png[/IMG]
HTML
<img src="https://ezbanners.org/shields/github-projects/YOUR-UUID/latest-release.png" alt="Latest Release badge" />
Open Issues
Markdown

BBCode
[IMG]https://ezbanners.org/shields/github-projects/YOUR-UUID/issues-open.png[/IMG]
HTML
<img src="https://ezbanners.org/shields/github-projects/YOUR-UUID/issues-open.png" alt="Open Issues badge" />
Sync workflow
- Create a GitHub Project from the workspace and enter
owner/repo. - Choose whether to import repo stats, releases, and issues.
- Run a manual sync or enable auto-sync. Scheduled syncs run through
github-projects:sync-auto. - Share the public project page or consume badge endpoints anywhere you need live repo metadata.
Banner ownership for standalone GitHub Projects is intentionally scoped as a follow-up. This first phase ships repository sync, public pages, and shields without changing existing banner source assumptions.