-
-
Notifications
You must be signed in to change notification settings - Fork 716
Module: github
Judson Lester edited this page Oct 5, 2022
·
14 revisions
This module shows the unread notification count using the GitHub API.
NOTE: This module requires the project to be built with cURL support.
You will need to generate a GitHub personal access token where at least notifications
is in the scope.
[module/github]
type = internal/github
; Accessing an access token stored in file
token = ${file:/path/to/file/containing/github/access.token}
; Accessing an access token stored in an environment variable
token = ${env:GITHUB_ACCESS_TOKEN}
; The github user for the token
; Effectively required; otherwise the module uses a deprecated method of fetching
; notifications, which has stopped working
user = github_user
; Whether empty notifications should be displayed or not
empty-notifications = false
; Number of seconds in between requests
interval = 10
; Github API URL
; Default: https://api.github.com/
api-url = https://hub.example.org/api/v3/
; Available tags:
; <label> (default)
format = <label>
; Available tokens:
; %notifications% (default)
; Default: Notifications: %notifications%
label = %notifications%
; Used when GitHub can't be reached
; Available tags:
; <label-offline> (default)
format-offline = <label-offline>
; Available tokens:
; None
; Default: Offline
label-offline = Offline
- π Home
- βΉοΈ Help
- βοΈ Configuration
- π¨ Formatting
- π Fonts
- π₯ Actions
- ποΈ Compiling
- π§ Debugging your Config
- π¬ Inter process messaging
- π€« Known Issues
- π¦ Packaging Polybar
-
For Developers:
- π Release Guidelines
- π¨ Style Guide
- π§ͺ Testing
- π§ Distro Specific Setup
- Modules: