github-reporadar 0.7.0 → 0.9.0

package/README.md

@@ -161,6 +161,12 @@ npx github-reporadar --org example-company --watch 1m
 
 初回の同期では何も出しません。溜まっていた分を一斉に出すと、新しく起きたことが埋もれるためです。画面のバッジと通知は次の版で入ります。
 
+出す順は「誰が止まっているか」で3つに分け、同じ組の中では組織のrepoを先に置きます。個人のrepoは下にまとまります。依存更新のPRのように、botが起こしたレビュー依頼は「他人を待たせている」には入れません。人は止まっていないためです。
+
+一覧は「何が起きたか」ではなく「どこで起きたか」で1行にします。同じPRにレビューが7回付いても1行で、見出しは最新のもの、残りは「ほか6」と添えます。1つのPRを7行に割ると、1行ずつ既読にしても同じPRの別の行が残り、読んでも減らないように見えるためです。
+
+読んだものはその場で一覧から消えます。1件ずつの「既読」と、リンクを開いたときの既読があり、どちらもその行にまとまっている出来事をまとめて消します。それより古い未読は残ります。「すべて既読」は時刻で一気に消します。消えたものは「履歴」で見られます。
+
 ### 平日の勤務時間だけ動かす(macOS)
 
 launchdで平日11:00に起動し、19:00に停止します。土日は動きません。
@@ -207,7 +213,7 @@ launchdは対話シェルの`PATH`を継がないので、`install.sh`が実行
 
 1. 朝、http://127.0.0.1:5177/ を開く。ブックマークしておく
 2. フィルターバーの札で今日やることを決める(レビュー待ちの自分のPR、自分がレビューするPR、Draft、手を付けていないissue)
-3. 受信箱に未読が付いたら開く。番号を押すとGitHubへ飛ぶ。読み終えたら「すべて既読」
+3. 受信箱に未読が付いたら開く。番号を押すとGitHubへ飛び、その1件は一覧から消える。まとめて消すときは「すべて既読」、振り返るときは「履歴」
 4. 迷ったら壁打ちで「今日の作業順を決めたい」と聞く
 
 初回だけ、受信箱の「通知を許可」を1回押してください。ブラウザを閉じている間の出来事も`events.json`に溜まるので、翌朝に開けば読めます。
@@ -236,10 +242,14 @@ launchdは対話シェルの`PATH`を継がないので、`install.sh`が実行
 
 ### Confluenceとの齟齬を出す(Atlassian連携)
 
-ページを書いたあとに実装が進んだものを「Wiki要確認」として出します。自分が関わったページを取り、本文と題に出てくるrepo名を拾い、そのrepoのpushがページ更新より新しければ挙げます。
+ページを書いたあとに実装が進んだものを「Wiki要確認」として出します。本文と題に出てくるrepo名を拾い、そのrepoのpushがページ更新より新しければ挙げます。自分が関わったページと、見張っているフォルダの配下が対象です。他人が書いたページには「他人のページ」と添えます。
 
 前提はこうです。値そのものは実装が正で、ページはその意図と使い方を書く場所です。だから食い違いが出たときに直す先はページのほうです。押すとそのページが開きます。
 
+1ページ1行です。1枚のページが4つのrepoに触れていれば、repoは遅れの大きい順に並べて「ほか3」と添えます。repoごとに行を割ると、同じ題が何度も並びます。
+
+「確認」を押すとその行は消え、数が減ります。押した時点でいちばん新しかったpushを覚えていて、そのあとに実装が進めばまた出ます。Wikiのページは閉じることがなく残り続けるので、GitHubのPRのように「解決したら終わり」になりません。だから人が見て「いまは直さない」と決めたものを数から外せるようにしています。消したものは「履歴」で見られます。
+
 トークンはファイルに置かず、macOSのキーチェーンから実行時に取ります(`gh`と同じ考え方)。JiraとConfluenceは同じサイトと同じトークンを使います。
 
 ```bash
@@ -258,6 +268,14 @@ ENV
 
 `RR_CONFLUENCE_SPACES="EXAM OTHER"`でスペースを絞れます。省略すると自分が関わった全ページです。
 
+### 決まった場所を見張る
+
+`RR_CONFLUENCE_FOLDERS="2149875783"`(`--confluence-folder`)を足すと、そのフォルダの配下は自分が関わっていないページも取ります。誰かが足したページは「Confluenceにページが追加」、直したページは「Confluenceのページが更新」として受信箱に出ます。IDの代わりにフォルダのURLをそのまま貼っても通ります。
+
+自分が関わったページだけを取る既定では、他人が新しく作ったページは取得の対象にすら入りません。設計やUIのルールのように、置き場所は決まっているが書き手が自分とは限らないものは、場所のほうを指定します。
+
+追加として出すのは、前回の同期より後に作られたページだけです。見張る場所を足した日に、過去のページが一斉に鳴るのを避けるためです。齟齬(Wiki要確認)の対象は今までどおり自分が関わったページだけで、見張っている場所のページは件数に混ざりません。
+
 拾うのは、そのPCが取得しているrepoの名前だけです。知らない語をrepo名として扱うことはありません。名前だけで拾うのは、記号か数字を含むもの(`sdpf-thing`)か8文字以上のものです。`ui`や`design`のように普通の単語と同じ綴りのrepoは、owner付き(`example-org/design`)かGitHubのURLで書かれているときだけ拾います。本文の地の文に当たるのを避けるためです。
 
 別のownerに同じ名前のrepoがあるときも、名前だけでは決めずowner付きを求めます。