pi-gh-footer
v0.1.1
Published
Compact GitHub PR status for pi-footer
Maintainers
Readme
pi-gh-footer
Compact PR status for Pi + pi-footer: #41208 · 3 1. Nerd Font glyphs, colored passed/running/failed indicators (only nonzero states appear), and an OSC 8 link on only the PR number.
Maple Mono NF:

Victor Mono Nerd Font:

Requires git, authenticated gh, a Nerd Font, and an OSC 8-capable terminal.
pi install npm:pi-footer
pi install npm:pi-gh-footerDisable pi-pr-status if installed (it writes the same status key); reload Pi. In /footer, choose one of:
- Extension Status:
externalStatusKey: "pr-status"— complete summary, compatible with existing footer config. Usefg: "default", no extra icon. - Event Value: set
widgetIdto any ID below and arrange/style widgets in pi-footer. Events usepi-footer:update-widgetwith{ widgetId, value: string | null }; missing PRs clear values.
| Event widget ID | Value |
| --- | --- |
| gh-pr | complete colored summary |
| gh-pr-number | linked #41208 |
| gh-pr-state-icon / gh-pr-state | colored PR icon / open, merged, closed |
| gh-pr-checks | colored check-circle / clock / x-circle + counts |
| gh-pr-passed / gh-pr-running / gh-pr-failed | nonzero counts (otherwise cleared), for custom icons/colors |
| gh-pr-repo / gh-pr-title | repository / title |
Example custom widgets: gh-pr-number with icon , then the three raw counts with icons , , and foregrounds green/yellow/red. The current branch's PR takes priority; otherwise a PR URL in user input is used. Updates every 30 seconds.
Development: npm ci && npm test && npm run typecheck. Screenshots: vhs demo/maple-mono.tape / vhs demo/victor-mono.tape (from repo root; install the named fonts first).
Releasing
The first release (0.1.0) is published manually with npm publish --access public after logging in to npm. Do not push v0.1.0 after publishing it: the workflow would try to publish the same version again.
For subsequent releases, update the version in package.json and package-lock.json (for example, npm version patch --no-git-tag-version) and merge the change into main. Tag that commit with the matching version (for example, git tag v0.1.1 && git push origin v0.1.1). The release workflow checks the tag, runs typechecking and tests, and publishes to npm using trusted publishing. Stable releases use the latest dist-tag; prereleases use next.
Configure the npm trusted publisher for GitHub Actions with owner championswimmer, repository pi-gh-footer, workflow release.yml, no environment, and permission to publish. No npm token secret is needed.
