Docs

GitHub Projects

Standalone repository sync, auto-imports, and GitHub Project badge endpoints.

What the module does

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

  • label overrides the left-hand badge text. Example: ?label=repo%20health.
  • color overrides the metric color with a hex value like 0969da or 4c1.
  • style changes the shield style. Supported values follow the shared shield renderer: flat, flat-square, plastic, and for-the-badge.

Copyable embed examples

Repository
Markdown ![Repository](https://ezbanners.org/shields/github-projects/YOUR-UUID/repo.png)
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 ![GitHub Stars](https://ezbanners.org/shields/github-projects/YOUR-UUID/stars.png)
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 ![Latest Release](https://ezbanners.org/shields/github-projects/YOUR-UUID/latest-release.png)
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 ![Open Issues](https://ezbanners.org/shields/github-projects/YOUR-UUID/issues-open.png)
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

  1. Create a GitHub Project from the workspace and enter owner/repo.
  2. Choose whether to import repo stats, releases, and issues.
  3. Run a manual sync or enable auto-sync. Scheduled syncs run through github-projects:sync-auto.
  4. 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.