日報ジェネレーター

nippo-generatorは日報を自動生成できるツールです。

その日に積んだコミットやSlackでの発言から自動で日報を生成します。

Installation

Homebrew

$ brew install masatoraatarashi/nippo/nippo

go get

Install

$ go get github.com/MasatoraAtarashi/nippo-generator

Update

$ go get -u github.com/MasatoraAtarashi/nippo-generator

How to use

1. SlackのAPIトークンを取得

こちらの手順を参考にSlackのAPIトークンを取得してください。

User Token Scopesでsearch:readを指定してください。

2. 初期化する

$ nippo init

上記のコマンドで$HOME/.nippo.yamlという設定ファイルが生成されます。

3. 設定ファイルを編集する

生成された設定ファイルを編集してください。

$HOME/.nippo.yaml

template:
    #日報に含めたい見出しを自由に設定してください。
    - 今日やったこと
    - 明日の予定
    - 所感・連絡事項
    - git
    - slack
git:
    heading: "git"
    repositories: 
        #コミットを取得したいディレクトリの絶対パスを記入してください。
        - "Users/MasatoraAtarashi/workspace/hogehoge"
        - "Users/MasatoraAtarashi/workspace/hogehoge2"
slack:
    token: "" #Slack APIトークンを記入してください。
    username: "" #Slackのユーザ名を記入してください。

4. 日報を生成する

$ nippot generate

出力例

# 2021-05-06
## 今日やったこと


## 明日の予定


## 所感・連絡事項


## git
### hogehoge(3 commits)
 - 7ae0175 Add count option
 - 7335722 Add slack to default config
 - 3bcd230 Add slackname option

### hogehoge2(1 commits)
 - 3bcd230 Update README

## slack
 - `よろしくお願いいたします！` (random)
 - `こんにちは` (テスト)

5. その他

設定ファイル($HOME/.nippo.yaml)の"template"から"git"や"slack"という項目を消せば、コミットやslack上の発言を日報に含めないようにすることができます。

Options

-c, --count int8         Specify count of remark to get (default 100)
-d, --date string        Specify date like <2021-04-24>
-g, --gituser string     Specify git username
-h, --help               help for generate
-s, --slackuser string   Specify slack username

Author

MasatoraAtarashi