github-issues
Summary
Section titled “Summary”Loads the zdharma-continuum/zsh-github-issues plugin, which subscribes to GitHub repositories and displays new-issue notifications under the shell prompt using zinit’s notify ice.
Syntax / Usage
Section titled “Syntax / Usage”zi pack for github-issueszi pack"compact-message" for github-issuesAvailable profiles: default, compact-message.
Details
Section titled “Details”- Provides: in-prompt GitHub issue notifications via the
notifyice; requiresgithub-issues-srv(the companion service package) to be loaded for data collection. defaultprofile ices:git,lucid,on-update-of"~/.cache/zsh-github-issues/new_titles.log",notify"New issue: $NOTIFY_MESSAGE",atpull"%atclone".compact-messageprofile: identical ices butnotifyvalue is just"$NOTIFY_MESSAGE"(no"New issue: "prefix).- The
on-update-ofice triggers the notification check whenever thenew_titles.logcache file changes (written by thegithub-issues-srvservice).
Examples
Section titled “Examples”# Notifications with "New issue:" prefixzi pack for github-issues
# Notifications with compact message onlyzi pack"compact-message" for github-issuesCaveats / Common Mistakes
Section titled “Caveats / Common Mistakes”- This package only handles display; the
github-issues-srvpackage must also be loaded to poll GitHub and write the log file.
See Also
Section titled “See Also”- pkg-github-issues-srv — companion service that polls GitHub
- pkg-overview — how
zi packworks