Sync index.md with README.md in thinreports/thinreports

[hidakatsuya]

目的

index.md を thinreports/thinreports の READMD.md と同期するようにします。

方針

このリポジトリの GitHub Actions で以下を定義します。

• 1時間ごとに実行する
• thinreports/thinreports の README.md を取得し、index.md を構築
• 結果 index.md に変更点があれば push する

その他の選択肢

その他にもいくつかの選択肢がありますが、それぞれ以下の理由で却下しました。

1. thinreports/thinreports の GitHub Actions として、README.md の更新でトリガーするワークフローを定義する。そのワークフローで、index.md を構築し、thinreports/thinreports.github.io に push する
   • -> 人に依存しない方法としては、Deploy Keys を使う方法が良いが、ワークフローの実装が割と複雑
2. 同様に thinreports/thinreports の GitHub Actions として README.md の更新でトリガーするワークフローを定義する。ただし、そのワークフローは、thinreports/thinreports.github.io に対して「READMD.md を更新した」というイベントを dispatch するだけにする。thinreports.github.io では、その「README.mdを更新した」というイベントで発火するワークフローを定義し、README.md を取得して構築、push する
   • -> 責務が分離されていて、かつリアルタイムに同期できるが、PTA (Personal Access Token) が必要。人に紐づくことになってしまうことはできるだけ避けたい

人(PTA)に紐づくことは避けたいというのが前提にあり、かつシンプルさも考慮してこの方法を採用しました。。また、同期はリアルタイムである必要もありません。

動作テスト

手元で node .github/workflows/update-index.js を実行して確認しました。

この後の対応

このワークフローは、master にマージしないと動作確認できません。一度マージして実際に試しつつ調整します。

[hidakatsuya]

@maeda-m レビューお願いします

[hidakatsuya]

動作確認して良さそうならコメントアウトする

[maeda-m]

@hidakatsuya いつもありがとうございます。

人(PTA)に紐づくことは避けたいというのが前提にあり、かつシンプルさも考慮してこの方法を採用しました。

また、同期はリアルタイムである必要もありません。

なるほど。理解しました。

LGTM!

[hidakatsuya]

マージして調整しました。概ね良さそうです。

差分がある場合はこんな感じで自動的に push されます。
9005f54

[hidakatsuya]

スケジュールでも実行されました。
https://github.com/thinreports/thinreports.github.io/runs/4279199215?check_suite_focus=true

ただ、16:23 GMT に実行されたのが正しいのかわからんけど。

[hidakatsuya]

1時間間隔だと too much な気がするので、日次に変更しました。毎日 0:00 UTC に実行されます。
225af5d