Print today's your GitHub activity for issues and pull requests.
github-nippou
[
][Test] [][Go Report Card] [
][Go Reference] [
][DeepWiki]
[Test]: https://github.com/masutaka/github-nippou/actions/workflows/test.yml?query=branch%3Amain [Go Report Card]: https://goreportcard.com/report/github.com/masutaka/github-nippou/v4 [Go Reference]: https://pkg.go.dev/github.com/masutaka/github-nippou/v4 [DeepWiki]: https://deepwiki.com/masutaka/github-nippou
Print today's your GitHub activity for issues and pull requests.
This is a helpful CLI when you write a daily report in reference to GitHub. Nippou is a japanese word which means a daily report.
Installation
Grab the latest binary from the releases page.
On macOS you can install or upgrade to the latest released version with Homebrew:
$ brew install masutaka/tap/github-nippou
$ brew upgrade github-nippouIf you're interested in hacking on github-nippou, you can install via go install:
$ go install github.com/masutaka/github-nippou/v4@latestAlso you can use make command, it's easy to build github-nippou:
$ make deps
$ make
$ ./github-nippouSetup
$ github-nippou init
The initialization will be update your Git global configuration file.
- Add
github-nippou.user - Add
github-nippou.token - Create Gist, and add
github-nippou.settings-gist-idfor customizing output format (optional)
Usage
$ github-nippou help
Print today's your GitHub activity for issues and pull requests
Usage: github-nippou [flags] github-nippou [command]
Available Commands: completion Generate the autocompletion script for the specified shell help Help about any command init Initialize github-nippou settings list Print today's your GitHub activity for issues and pull requests open-settings Open settings url with web browser version Print version
Flags: -d, --debug Debug mode -h, --help help for github-nippou -s, --since-date string Retrieves GitHub user_events since the date (default "20231028") -u, --until-date string Retrieves GitHub user_events until the date (default "20231028")
Use "github-nippou [command] --help" for more information about a command.
You can get your GitHub Nippou on today.
$ github-nippou
masutaka/github-nippou
- v3.0.0 by @masutaka
- Enable to inject settingsgistid instead of the settings by @masutaka merged!
- Add y/n prompt to sub command \
init\ by @masutaka merged!
- Add sub command \
open-settings\ by @masutaka merged!
- Dockerize by @masutaka merged!
Usage Examples as a library
The following projects use github-nippou as a library:
- https://github.com/MH4GF/github-nippou-web
- https://github.com/NoritakaIkeda/GitJournal
Optional: Customize Output Format
Customize the list output format as needed. Configurations are stored in a Gist. Running github-nippou init creates your Gist and adds its ID to github-nippou.settings-gist-id.
View the default configuration here.
Available Properties
format.subject
| Property | Type | Description | | --- | --- | --- | | subject | string | Represents the repository name. |
format.line
| Property | Type | Description | | --- | --- | --- | | user | string | Displays the username of author of the issue or pull request. | | title | string | Displays the title of the issue or pull request. | | url | string | Displays the URL of the issue or pull request. | | status | string \| nil | Displays the status, utilizing the format in dictionary.status. |
format.dictionary.status
| Property | Type | Description | | --- | --- | --- | | closed | string | Displays when the issue or pull request is closed. | | merged | string | Displays when the pull request is merged. Applicable to pull requests only. |
Limitations and Latency
github-nippou uses the GitHub List events for the authenticated user API.
This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
As noted above, the events retrieved may be delayed by anywhere from 30s to 6h.
:link: REST API endpoints for events \- GitHub Docs
Only events created within the past 30 days will be included. Events older than 30 days will not be included (even if the total number of events in the timeline is less than 300).
github-nippou can create past daily reports, but only events from the past 30 days and up to 300 events can be retrieved.
Contributing
- Fork it ( https://github.com/masutaka/github-nippou/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Contributors
Made with contrib.rocks.
External articles
In Japanese
- いつも日報書くときに使っているスクリプトをGem化した | マスタカの ChangeLog メモ
- github-nippou v0.1.1 released | マスタカの ChangeLog メモ
- github-nippou v1.1.0 and v1.1.1 released | マスタカの ChangeLog メモ
- github-nippou v1.2.0 released | マスタカの ChangeLog メモ
- 社内勉強会で github-nippou v2.0.0 をライブリリースした | マスタカの ChangeLog メモ
- github-nippou v3.0.0 released | マスタカの ChangeLog メモ
- github-nippou という gem を golang で書き直したという発表をした - Feedforce Developer Blog
- github-nippou を golang で書き換えて v4.0.1 リリースしてました | マスタカの ChangeLog メモ
- github-nippou のリリースを gox+ghr の手動実行から、tagpr+goreleaser の自動実行に変えた | マスタカの ChangeLog メモ
- github\-nippou の Web 版を App Router \+ Go \+ Vercel で作った \| Hirotaka Miyagi
- github\-nippou のリリース時に formula ファイルも自動更新するようにした \| マスタカの ChangeLog メモ
- github-nippou 10 周年 🎉 | マスタカの ChangeLog メモ
