【SRETT#6】業務の延長線上で OSS に初コミットした話

3-shake SRE Tech Talk #6
2023年6月22日19時〜21時
https://3-shake.connpass.com/event/279426/
https://www.youtube.com/watch?v=Qjsh4_e2zRQ

Transcript

1. 業務の延長線上で OSS に初コミットした話 株式会社スリーシェイク 下村俊貴
2. 自己紹介｜下村俊貴 toshikish 2 2018年〜 Web アプリ開発（PHP） 2019年〜 自社サービスの クラウドアーキテクト（AWS） 2021年〜 スリーシェイクに入社 Sreake 事業部にて SRE 支援業務（AWS メイン）
3. 01 OSS コントリビューション色々 02 業務の延長線上で OSS コミットした体験 03 まとめ 目次 3
4. OSS コントリビューション色々 4 01
5. • 自分で立ち上げる。 • ドキュメントの追加・修正・翻訳。 • バグ報告・修正。 • 既存 OSS のイシューを見つけて Pull Request を送る。 • 大規模ソフトウェアを手探って機能を追加してみる。 • 業務の延長線上でパッチを送る。 OSS コントリビューション方法は色々ある 5
6. • やること：自分の GitHub にリポジトリを上げる。以上 • 公開したいものがあればとても手軽に OSS コントリビューション できる。 • デメリット ◦ 作った OSS が使われるとは限らない。 自分で立ち上げる 6
7. 一番多いケース • 自分で作りたいものがなくても参加できる。 • デメリット ◦ 取り組めるイシューや直すべきバグを見つけるハードルが高い。 ◦ すでに good first issue を取られていることが多い。 ◦ 手段が目的化すると良いアウトプットが出ない。 ▪ 一昔前に問題になった Hacktoberfest がその例。 https://blog.domenic.me/hacktoberfest/ 既存 OSS のイシューを見つけて Pull Request を送る 7
8. 大規模ソフトウェアを手探る（東大 EEIC の実験） https://doss.eidos.ic.i.u-tokyo.ac.jp/ • 他の方法よりもスキルと達成感を得られる。 • デメリット ◦ 授業20コマ分の時間と労力が必要。 ◦ TA がいないと厳しい。 ◦ ここまでしてもマージされるのは一部。 大規模ソフトウェアを手探って機能を追加してみる 8
9. 業務で出会ったバグを修正する・ちょっとした機能を追加する。 • 目標が明確なのでやり遂げやすい。 • 業務の中ですでに背景知識を理解している。 • マージされやすい。 👉 OSS コントリビューションを始めるには最適 業務の延長線上でパッチを送る 9
10. 業務の延長線上で OSS コミットした体験 10 02
11. セルフホストした GitLab で，日次バックアップを DR 環境に復元 • backup-utility というスクリプトがついていたので利用した。 • バグ：復元対象の除外指定が効かない。 業務でやろうとしたこと・遭遇したバグ 11 $ echo yes | backup-utility --restore \\ --skip registry --skip uploads --skip pages ... 2022-11-15 02:33:10 +0000 -- done Restoring pages ... sync existing of pages failed pages をスキップに したのに pages を復元しよう とする
12. • ヘルプでコマンドの使い方を確認：問題なし。 • backup-utility の中身を読んで処理を追う。 ◦ fetch_remote_backup ◦ unpack_backup ◦ gitlab-rake gitlab:backup:db:restore ◦ gitlab-rake gitlab:backup:repo:restore ◦ （gitlab-rake gitlab:backup:builds:restore はスキップ） ◦ （object-storage-restore pages はスキップのはずなのになぜか 実行されている）☞スキップ判定処理が怪しい。 ◦ gitlab-rake cache:clear ◦ cleanup 原因究明 1/2 12
13. スキップ判定処理を追う。 • スキップ対象を格納した変数 ◦ 原因判明：この書き方だと配列の先頭の要素 しか出力されない。 ◦ 修正：配列の全部の要素をコンマ区切りで出力するにはこう書く。 原因究明 2/2 13 export SKIPPED=$(echo ${skipped_line#:skipped:},${skipped_via_flag}) --skip フラグを 受け取る配列 $(IFS=,; echo "${skipped_via_flag[*]}")
14. 参考にしたページ • Contribute to GitLab • Contribute to GitLab development コントリビューションガイドを探して読む 14 👉 やるべきこと 1. Code of Conduct を読む。 2. イシューを探すか作る。 3. （Development Kit セット アップ：今回は不要） 4. Merge Request を開く。
15. • このバグのイシューを探す→ないので作る。 ◦ https://gitlab.com/gitlab-org/gitlab/-/issues/383645 イシューを立てる 15
16. • Fork → Push → Merge Request 作成 ◦ https://gitlab.com/gitlab-org/build/CNG/-/merge_requests/1210 Merge Request を送る 16
17. 関連箇所の修正も提案される。 コメントを受けて返答・修正する 17
18. マージされる 🚀 18
19. GitLab トラブル事例紹介｜Sreake ブログ https://sreake.com/blog/gitlab-trouble-case-study/ 詳しくはブログ記事で 19
20. まとめ 20 03
21. • 普段の業務で出会ったバグの修正やちょっとした機能追加は OSS コントリビューションしやすい。 • ポイント ◦ コントリビューションガイドを探して読んで，それに従う。 ◦ 業務上の機密情報を除外して一般化して記述する。 ◦ 可能な場合はテストコードも書く。 まとめ 21