https://github.com/mh4gf/github-nippou
Print today's your GitHub action
https://github.com/mh4gf/github-nippou
Last synced: 5 months ago
JSON representation
Print today's your GitHub action
- Host: GitHub
- URL: https://github.com/mh4gf/github-nippou
- Owner: MH4GF
- License: mit
- Fork: true (masutaka/github-nippou)
- Created: 2023-10-16T00:47:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-02T14:19:19.000Z (over 2 years ago)
- Last Synced: 2025-10-11T04:58:34.636Z (8 months ago)
- Language: Go
- Homepage:
- Size: 387 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# github-nippou
[][github actions]
[][license]
[][godoc]
[github actions]: https://actions-badge.atrox.dev/masutaka/github-nippou/goto?ref=master
[license]: https://github.com/masutaka/github-nippou/blob/master/LICENSE.txt
[godoc]: https://godoc.org/github.com/masutaka/github-nippou
Print today's your GitHub activity for issues and pull requests.
This is a helpful tool 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](https://github.com/masutaka/github-nippou/releases) page.
On macOS you can install or upgrade to the latest released version with Homebrew:
```
$ brew install masutaka/github-nippou/github-nippou
$ brew upgrade github-nippou
```
If you're interested in hacking on `github-nippou`, you can install via `go install`:
```
$ go install github.com/masutaka/github-nippou@latest
```
Also you can use make command, it's easy to build `github-nippou`:
```
$ make deps
$ make
$ ./github-nippou
```
## Setup
$ github-nippou init
The initialization will be update your [Git global configuration file](https://git-scm.com/docs/git-config#Documentation/git-config.txt-XDGCONFIGHOMEgitconfig).
1. Add `github-nippou.user`
2. Add `github-nippou.token`
3. Create Gist, and add `github-nippou.settings-gist-id` for 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](https://github.com/masutaka/github-nippou/issues/59) by @[masutaka](https://github.com/masutaka)
* [Enable to inject settings_gist_id instead of the settings](https://github.com/masutaka/github-nippou/pull/63) by @[masutaka](https://github.com/masutaka) **merged!**
* [Add y/n prompt to sub command \`init\`](https://github.com/masutaka/github-nippou/pull/64) by @[masutaka](https://github.com/masutaka) **merged!**
* [Add sub command \`open-settings\`](https://github.com/masutaka/github-nippou/pull/65) by @[masutaka](https://github.com/masutaka) **merged!**
* [Dockerize](https://github.com/masutaka/github-nippou/pull/66) by @[masutaka](https://github.com/masutaka) **merged!**
```
## 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](./config/settings.yml).
### 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. |
## Contributing
1. Fork it ( https://github.com/masutaka/github-nippou/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Maintenance
It's possible to release to GitHub using `make` command.
```
$ git checkout master
$ git pull
# Edit and commit lib/version.go
$ git push origin master
$ make dist
$ make release
```
## External article
In Japanese
[github-nippou - GitHubから日報を作成 MOONGIFT](http://www.moongift.jp/2016/06/github-nippou-github%E3%81%8B%E3%82%89%E6%97%A5%E5%A0%B1%E3%82%92%E4%BD%9C%E6%88%90/)