🐻

Deno cronやOpenTofu、CI高速化など｜Productivity Weekly (2023-12-06号)

Futa Hirakoba

2023/12/26に公開

ProductivityWeekly

生産性向上

idea

こんにちは。サイボウズ株式会社生産性向上チームの平木場です。

僕たち生産性向上チームは毎週水曜日に Productivity Weekly という「1 週間の間に発見された開発者の生産性向上に関するネタを共有する会」を社内で開催しています。
本記事はその時のネタをまとめたものです。

2023-01-25 号から、基本的に隔週で連載することとしました。たまに単独でも投稿するかもしれません。
今週は 2023-12-06 単独号です。

今回が第 135 回目です。過去の記事はこちら。

news 📺

GitHub Copilot – November 30th Update - The GitHub Blog

GitHub Copilot の 11 月のアップデートまとめです。
大まかに箇条書きで紹介します。

Copilot Chat の使うモデルが GPT-4 となった
VSCode でのコード参照がパブリックベータ化
- コード参照は、Copilot の提案に近しいコードを OSS から検索して提示する機能。近しいコードのライセンスやリポジトリを参照できる
エージェント機能を導入
- @workspace でワークスペース内に詳しいエージェントを利用。@vscode で VSCode 自体に詳しいエージェントを利用
VSCode でのコミット時にコミットメッセージを補完する機能を追加
JetBrains IDE において Copilot の提案を部分的に受け入れ可能に
- macOS の場合、Command + → で部分的に提案を受け入れられる。VSCode では以前から対応されていた機能
その他様々な改善

GitHub Copilot にはやはりだいぶ力を入れているようで、どんどん便利な機能が入っていきますね。個人的には IntelliJ IDEA をよく使っているので、JetBrains IDE での Copilot の提案が部分的に受け入れられるようになったのが特に嬉しいです。

GitHub Copilot 使いの方は頭に入れておくと良いですね。

本項の執筆者: @korosuke613

Amazon CloudWatch Logsの異常検出をCloudFormationで設定してみた #AWSreInvent | DevelopersIO

Amazon CloudWatch Logs に異常検出機能が追加されました。この記事は、クラメソさんによる異常検出機能の紹介と試してみた内容になります。
異常検出機能（log anomaly detection）はロググループに新たなパターンのログイベントがあると異常だと検出する機能のようです。

記事では、実験用 Lambda の作成から始まり、異常検出機能の CloudFormation による設定、トレーニング完了後に Lambda で ERROR ログを発生させて異常検出が発生するか確認するという流れになっています。
実際の画面を貼ってくれているためどんなものかイメージが湧きやすいです。

異常検出機能自体は無料とのことなので、CloudWatch Logs を使っている方はぜひ試してみてください。

本項の執筆者: @korosuke613

Announcing Deno Cron

https://deno.com/blog/cron

Deno に cron 機能が追加され、Deno がホスティングしている Deno Deploy の環境で簡単にスケジュール実行ができるようになりました。

// ブログのサンプルコードより
Deno.cron("Sample cron job", "*/10 * * * *", () => {
  console.log("This will run every 10 minutes");
});

デプロイする.ts にこのようなコードを書くと、 Deno.cron() のブロック内のコードをスケジュールで実行してくれるようになります。非常にシンプルですね。

Deno は既に Deno KV や Deno Queues などちょっとした DB 的な機能も既に提供しており^[1]、Deno Deploy の環境では自分で DB を用意しなくてもこれらの機能を使うことで永続化やキューイングなどが可能です。そこに今回の cron が追加されたことで、ちょっとした自動化のスクリプトなどを動かすのに便利な環境になりそうだなと思いました。

自分も早速以前に作成した bluesky へ自動ポストする bot を Deno Deploy + Deno KV で動かそうと試しています。

本項の執筆者: @Kesin11

know-how 🎓

CIを高速化する技術⚡️ - 10X Product Blog

10X さんによる、CI を高速化するためのテクニックや事例、取り組み紹介記事です。

キャッシュの利用やマシンスペックの最適化などの基本的なことはもちろん、テスト分割やジョブの依存関係・実行順序の見直しなどちょっとテクニカルなことも書かれています。高速化を実践してみて、改善前と改善後でどうテスト実行時間が変わったかなどの事例も載っています。

最後には著者が高速化を実現するために日々取り組んでいることが載っており、新たな高速化アイデアを作り出すのに参考になりそうです。
個人的には 「CI 遅い…待てない…」と日々思い続ける が「わかる...」という気持ちになりました。だんだん慣れちゃうんですよねほんと。

各テクニックでは、CircleCI、GitHub Actions の両方でどうすればいいかのヒントも示してくれているため、とりあえずやってみるの精神で試し始められると思います。

できうる限りで CI を高速化していきたいですね。

本項の執筆者: @korosuke613

Terraform職人のためのOpenTofu入門 #Terraform - Qiita

tfmigrate や tfupdate といった Terraform の補助ツールを開発していることで有名な @minamijoyo さんによる、OpenTofu^[2]入門記事です。（タイトルにもあるとおり Terraform をすでに使っている人向けです。）

Terraform と OpenTofu を取り巻く事情や歴史的背景や OpenTofu と Terraform の技術面・文化面での違い、OpenTofu の今後の展望(CNCF への参加についても)などが詳細に書かれており、大ボリュームな内容となっています。

Terraform との違いについては、レジストリ、プロバイダ、tfstate や test フレームワークなど、大きな機能ごとに比較しており、OpenTofu を試したことがない人でも Terraform との違いをある程度把握できます。

Terraform の Go パッケージがほとんど internal/ 以下に移動していたり、コミュニティからは設計レベルの変更を最近受け付けてなかったりといった、Terraform の OSS としての事情は正直なところ全然知らなかったため、大変勉強になりました。
OpenTofu ではコア機能をライブラリ化したり、RFC により設計変更を提案できるようにする方針であったりと、コミュニティでソフトウェアを育てていく思想であるようなので、個人的にはとても良いなと思っています。
最初登場した時は混沌となるからあまり歓迎していなかったのですが、この記事を読んで考えが大きく変わりました。今後が楽しみです。

OpenTofu に興味が湧いてきた方はぜひこの記事をお読みください。

本項の執筆者: @korosuke613

GitHub Actions workflowが完了したらデスクトップ通知を出す - valid,invalid

macOS において、GitHub Actions のワークフローが完了したらデスクトップ通知を出す方法を紹介する記事です。

macOS では AppleScript という言語を使うことにより、デスクトップ通知を出したりウィンドウを動かしたりといった操作ができます。
この記事では、AppleScript をターミナルから実行する組み込みコマンド osascript と GitHub CLI を組み合わせて、GitHub Actions のワークフローが完了したらデスクトップ通知を出す方法が紹介されています。
サンプルコードが書かれているため、すぐに試すことができます。

僕も使ってみたのですが、デスクトップ通知は気づかないことがあるので、アラートを出すようにしてみました。

alias ghn='gh run watch -i10 && osascript -e "display alert \"GitHub Actions workflow is done\" buttons {\"OK\"}"'

AppleScript では display alert でアラートを出せます^[3]。

OK ボタンだけある

例えば Flaky で時間のかかるようなテストを実行しなきゃいけない時などに、作業中にすぐにワークフローの実行完了を知ることができて（場合によっては re-run もできる）便利です。
割と簡単にできるので、似たようなことを考えている人はぜひ試してみてください。

本項の執筆者: @korosuke613

そのテスト、最後まで実行されていますか？　jestとnpm-run-allの恐るべき罠

最初は CI が不安定な原因の調査したところ、Jest がメモリ不足で完走できていなかったことが原因だと判明したので対処した話。で終わるかと思いきや、実は隠れていた npm-run-all の問題によって今まで実はテストが最後まで走っていなかったことが判明したという二重に恐ろしい話でした。

npm-run-all は自分も Node.js のプロジェクトで利用していたのですが、新しいバージョンがもう長いことリリースされていなかったことは知りませんでした。この機会に他の方法を検討しようと思います。

それと記事中では前半の Jest のメモリ不足の内容で軽く紹介されていただけですが、catchpoint/workflow-telemetry-action で GitHub Actions のジョブのメトリクスを簡単に見られるのは便利そうだと思いました。CI のマシンは以外と低スペックだったりするので、開発マシンと比較して動作が謎に不安定な場合は CPU やメモリが不足していないかを確認することを覚えておきたいです。

本項の執筆者: @Kesin11

GitHub Enterprise Server 3.11 is now generally available - The GitHub Blog

GitHub Enterprise Server 3.11 が GA になりました 🎉

追加された機能はたくさんありますが、個人的に便利そうな機能をいくつか紹介します。

リリースノート全体はこちら。

本項の執筆者: @Kesin11

tool 🔨

GitHub-hostedライクにAmazon ECSとAWS Lambdaでself-hosted runnerを管理するツールを作った | なぜにぶろぐ

以前から GitHub Actions のセルフホストランナーをオートスケールさせるための whywaita/myshoes を作られている whywaita さんがそのノウハウを活かして ECS で手軽にオートスケール可能なセルフホストランナーの基盤を構築するための whywaita/myshoes-serverless-aws を公開されました。

生産性向上チームの @uta8a が早速詳しい解説記事も公開してくれたので、詳しい仕組みが気になる方は whywaita さんの記事とあわせて uta8a さんの記事も参考になると思います。

本項の執筆者: @Kesin11

あとがき

大変遅くなってしまいすみません。12 月はとにかく忙しかったです（あとネタ多すぎ）。
年内はあと 2023-12-13 号を予定しています。~~2023-12-20 号はなんとも言えない。~~

サイボウズの生産性向上チームでは社内エンジニアの開発生産性を上げるための活動を行なっています。そんな生産性向上チームが気になる方は下のリンクをクリック！

脚注

2023/12/18 時点ではまだ beta ではあります。 ↩︎
OpenTofu 自体はこれまでもちょいちょい紹介してきましたね。 ↩︎
参考にしたサイト: AppleScriptの概要と主要コマンド(随時更新) - Kekeの日記 ↩︎
Litmus Test はみんな大好きリトマス試験のことを表していそうですね。酸性・アルカリ性を測定する紙を使った試験で、中学校の理科かなんかでやった記憶。 ↩︎

GitHubで編集を提案

サイボウズ生産性向上チーム 💪Publication

サイボウズ株式会社開発本部生産性向上チームです。サイボウズエンジニアの生産性を上げるために日々活動しています 💪

Deno cronやOpenTofu、CI高速化など｜Productivity Weekly (2023-12-06号)

news 📺

GitHub Copilot – November 30th Update - The GitHub Blog

Amazon CloudWatch Logsの異常検出をCloudFormationで設定してみた #AWSreInvent | DevelopersIO

Announcing Deno Cron

know-how 🎓

CIを高速化する技術⚡️ - 10X Product Blog

Terraform職人のためのOpenTofu入門 #Terraform - Qiita

GitHub Actions workflowが完了したらデスクトップ通知を出す - valid,invalid

そのテスト、最後まで実行されていますか？　jestとnpm-run-allの恐るべき罠

GitHub Enterprise Server 3.11 is now generally available - The GitHub Blog

tool 🔨

GitHub-hostedライクにAmazon ECSとAWS Lambdaでself-hosted runnerを管理するツールを作った | なぜにぶろぐ

read more 🍘

あとがき

Discussion

news 📺

GitHub Copilot – November 30th Update - The GitHub Blog

Amazon CloudWatch Logsの異常検出をCloudFormationで設定してみた #AWSreInvent | DevelopersIO

Announcing Deno Cron

know-how 🎓

CIを高速化する技術⚡️ - 10X Product Blog

Terraform職人のためのOpenTofu入門 #Terraform - Qiita

GitHub Actions workflowが完了したらデスクトップ通知を出す - valid,invalid

そのテスト、最後まで実行されていますか？ jestとnpm-run-allの恐るべき罠

GitHub Enterprise Server 3.11 is now generally available - The GitHub Blog

tool 🔨

GitHub-hostedライクにAmazon ECSとAWS Lambdaでself-hosted runnerを管理するツールを作った | なぜにぶろぐ

read more 🍘

あとがき

Discussion

そのテスト、最後まで実行されていますか？　jestとnpm-run-allの恐るべき罠