🗿

Productivity Weekly (2023-09-13号, 2023-09-06号)

Futa Hirakoba

2023/09/23に公開

ProductivityWeekly

生産性向上

idea

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

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

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

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

news 📺

⚠️ Node.js 16 is now end of life, please upgrade to Node.js 18.

前々からアナウンスされていた通り、Node.js 16 が 9/11 に EOL となりました。

Node.js の LTS 後のサポートは LTS から数えて通常 2 年半続くのですが、Node.js 16 は依存してるソフトウェアのサポート終了に合わせて 7 ヶ月近く早い EOL となりました。

多くの方が現在の LTS である Node.js 18 へ移行済みかと思いますが、まだ移行していない方は早めに移行しましょう。

本項の執筆者: @korosuke613

The OpenTF fork is now available!

https://opentf.org/fork

先日、HashiCorp が OSS 製品のライセンスを BUSL に変更する発表を受け、Terraform を OSS として継続するための団体、OpenTF Foundation が爆誕しました。OpenTF Foundation は生まれましたが、Terraform を fork したリポジトリはまだ公開されていませんでした。

しかし、先日、OpenTF Foundation が Terraform の fork を公開しました。opentffoundation/opentf です。ライセンスは変わらず MPL-2.0 です。

いまいちどこから fork したのかわかりませんが、opentf による最初のコミットは https://github.com/opentffoundation/opentf/commit/b9573d438bd539da85a72641330d4d600e926f1b のようです。

What will be the first release of OpenTF?

The first release will be 1.6.0-alpha, forked from the most recent commit that was still MPL-licensed.

FAQ によると、Terraform 1.6.0-alpha までは MPL ライセンスであるため、OpenTF の最初のリリースは 1.6.0-alpha までの変更が含まれていそうです。（ちなみに 1.6.0-beta からは BUSL となっています。）

リポジトリは公開されましたが、OpenTF はまだリリースされていません。どうやら、Terraform Registry が Terraform 以外で使えなくなったため、独自のレジストリを準備中とのことです。

Create initial OpenTF Registry. HashiCorp recently made some (unannounced) changes to the terms of the Terraform Registry, saying it may only be used with Terraform. To unblock the alpha release, we are launching an initial OpenTF Registry. We'll develop the official OpenTF Registry solution via an official RFC process later.

OpenTF Registry ができしだい、OpenTF がリリースされそうですね。

正直な話、個人的には Terraform の実装が分かれることでこれからの混沌は避けられないと思うので、あんまり歓迎はしていません。しかし、今まで Terraform で商売をしていた人たちにとっては死活問題なのでしょうがないのかなという気持ちです。

今後もウォッチしていきたいですね。

本項の執筆者: @korosuke613

actions/create-github-app-token: GitHub Action for creating a GitHub App Installation Access Token

GitHub 公式で GitHub Apps のトークンを払い出すアクション actions/create-github-app-token がリリースされました。

これまで GitHub Apps のトークンを払い出すアクションは公式に存在していなかったため、さまざまな 3rd party アクションが存在していました。

GitHub Apps の private key を渡さなければならない関係上、3rd party アクションの利用は特に慎重になる必要があったかと思います。
今回登場したアクションは GitHub 公式であるため、セキュリティ的にもメンテナンス的にも比較的安心して利用できそうです。

ただ、v1.2.1 時点だと、アクションを実行しているリポジトリのオーナーに関する権限しか取れないようです。トークンを取得したいオーナーが異なる場合は、機能追加されるまで 3rd party アクションを利用するのが良さそうです。

実は Cybozu でも cybozu/octoken-action という似たようなことをするアクションを OSS として出しています。こちらは target_account で別のオーナーを指定し、そのオーナーにインストールされた App の権限を取得できます。
しかし、今後は公式のアクションの利用を推奨していくことになりそうです。

（ちなみに、actions/create-github-app-token は Post run で払い出したトークンを revoke してくれます。セキュアでいいですねー）

皆さんも GitHub Apps のトークンを払い出すアクションを利用する際は、actions/create-github-app-token の利用を検討してみてください。

本項の執筆者: @korosuke613

Bun 1.0 | Bun Blog

https://bun.sh/blog/bun-v1.0

高速でオールインワンな JavaScript ランタイムを謳う Bun の v1.0 がリリースされました 🎉

2022/07 くらいにベータ版として登場した Bun は長らく v0.x 系のままでしたが、ついに v1.0 がリリースされました。
Bun がどういったソフトウェアであるのか、他のランタイムと比べてどう違うのかはこの記事を読めばだいたいわかるでしょう。

記事は v1.0 の変更点というよりかは、メジャーリリースされた Bun の説明がメインです。
前バージョンである v0.8 からの変更点は最後の方に載っています。

Changelog since v0.8

Next.js, Astro, and Nest.js are now supported!

個人的には Astro をサポートしたのが嬉しいです。僕のホームページ (korosuke613.dev) は Astro を使っているので、Bun の利用を試してみたいですね。

今まで特に Bun と触れ合ってこなかった人にとっては、知識をアップデートするチャンスです。気になる人は読んでみてください。

本項の執筆者: @korosuke613

マイクロソフト、お客様向けの Copilot Copyright Commitment を発表 - News Center Japan

Microsoft が Copilot Copyright Commitment という生成 AI の利用における保証を発表しました。
Microsoft の生成 AI サービスを使用した際、第三者に著作権侵害による訴訟の結果生じた不利な判決や和解の金額は Microsoft が負担するというものです。
対象には、Word、Excel、PowerPoint などに生成 AI を導入し、データの推論や、文書のプレゼンテーションへの変換をする Microsoft 365 Copilot や Bing Chat Enterprise、GitHub Copilot などが含まれます。
利用者は Copilot 製品のガードレールとコンテンツフィルター機能を有効にしている必要があり、意図して著作権侵害をするようなコンテンツを生成してはならないとのことです。

本項の執筆者: @r4mimu

Dual Static IP ranges for GitHub-hosted Larger runners - The GitHub Blog

GitHub Actions の Larger runner で Static IP を有効にした場合の IP レンジが 2 つに拡張されました。
これにより、ランナーは従来の 500 並列制限を超えることができるようになりました。
2 つの IP レンジは地理的に異なる場所に作成されるため、地域的な障害に対する冗長性を提供しているとのことです。
Static IP 機能を使用して新しく作成された Larger runner では、今後デフォルトで 2 つの IP 範囲が割り当てられるため、追加の操作は必要ありません。
既に Static IP を利用している場合でも IP レンジが拡張されるとのことなので、固定化された IP を通すファイアーウォールの設定をしていた場合は、新しい IP レンジを追加する必要があるので注意です。

本項の執筆者: @r4mimu

Organization Archiving general availability - The GitHub Blog

GitHun の Organization をまるごとアーカイブする機能が GA になりました。
Organization アーカイブを実行すると以下のようなことが行われます。

Organization 内のすべてのリポジトリをアーカイブ
新しいリポジトリの作成など、その Organization での活動を制限
Organization のプロフィールにアーカイブされたことを示すバナーを表示
Organization のオーナーにアーカイブされたことをメールで知らせる

コミュニティベースの Organization を閉じる際や Enterprise ならチームが解散した際にその Organization をまるごとアーカイブするという使い道がありそうです。

本項の執筆者: @r4mimu

Change your theme | Confluence Cloud | Atlassian Support

Confluence にダークテーマがきたようです。選択したテーマはアカウントに保存されるため他デバイスから Confluence を使用する場合にも適用されます。
ダークテーマにしてトップナビゲーションバーが正しく表示されない場合、ダークテーマと相性の悪いカスタムカラーを設定している可能性があるので、カスタムカラーを変更する必要があるとのことです。

本項の執筆者: @r4mimu

Built-in port forwarding | Visual Studio Code August 2023

Visual Studio Code v1.82 において、組み込みでポートフォワードする ngrok のような機能が追加されました。
ドキュメントは Port forwarding local services with VS Code になります。

デフォルトでは private モードとなっており、転送されたポートにアクセスするためには自身の GitHub アカウントが必要ですが、public モードにすると誰でもアクセスできるようになります。
GitHub Codespaces にあるポートフォワード機能が VS Code にも組み込まれたような感じですね。

セキュリティ上の理由で ngrok みたいなサービスの利用を禁止する組織もこれまであったと思います。
そういった組織のために、ポートフォワードを制限する方法も用意されています。ドメイン(global.rel.tunnels.api.visualstudio.com)をブロックするだけで済みそうなので、管理者も安心ですね（？）。

How are forwarded ports secured?

個人的にはエディタに載せるような機能なのか？とちょっと思ってしまいました。便利なのは間違いないので、気をつけて使いましょう。

本項の執筆者: @korosuke613

know-how 🎓

Actions Runner Controller Deep Dive！ - APC 技術ブログ

エーピーコミュニケーションズさんによる、GitHub Actions self-hosted runner 環境を構築するための GitHub 公式 OSS、Actions Runner Controller(ARC) の scale sets モードを深く解説した連載記事です。

scale sets モードは最近登場した方式であり、すでに GA となっています。
僕も以前調べたことがあります^[1]。

記事執筆時点（2023/09/23）では 3 つの記事が公開されています。

アーキテクチャ編
動作解説編
コード解説前編
コード解説後編？
Runner の監視編？

アーキテクチャ編ではどのようにランナーを用意、スケールするかを解説しています。リポジトリ荷ある説明文の要約がわかりやすいです。

動作確認編では実際に k8s クラスタへ ARC をインストールし、ジョブを動かしたり各設定項目が何を表すかなどを説明してくれています。さらにランナーで Docker の実行を実現するために ARC が用意している Docker in Docker を有効にする方法と actions/runner-container-hooks を利用する方法の 2 つを紹介してくれています。

コード解説前編では、ARC のコード解説をしてくれています。実際に ARC のすべてのコードを読んだようで、驚きます。前編と書かれている通り、ARC が起動してから各種リソースを作成するくらいまでが範囲となっています。
コード解説編はとてもボリュームが多く、読み応えがあります。僕はまだ途中までしか読めていません。

ここまで詳細に ARC の scale sets モードを解説してくれている記事は他にありません^[2]。
ARC の scale sets モードは複雑で動作を理解するのが難しいので、今後利用していく上でこの記事は大変参考になります。

残りの記事も楽しみです。

本項の執筆者: @korosuke613

octocov で任意のメトリクスを記録できるようにした（カスタムメトリクス） - Copy/Cut/Paste/Hatena

外部サービスを使わずに GitHub Actions 単独でカバレッジを表示できる octocov がカバレッジ以外に任意のデータも集計できる機能が追加されました。
こちらの記事ではサンプルとして go test -bench の結果を octocov が集計して pull-req に表示させる例が紹介されています。

自分も octocov にはお世話になっているので早速試してみました。pull-req の差分でバイナリサイズがどれだけ変化するかを見られると便利そうだと考えたので、バイナリではないのですが似たようなものとして GitHub Actions のリポジトリにコミットする.js のコードサイズ^[3]を octocov で集計してみました。

記事や octocov の README に詳しい説明はありますが簡単に紹介すると、カスタムメトリクスとして送りたいデータをJSON スキーマに従った JSON として生成し、k1LoW/octocov-action@v0 の action の環境変数で json のパスを指定するだけです。

今回は自分のactions のリポジトリの dist/ ディレクトリ以下の.js のファイルサイズを集計したかったので、 find と jq で JSON を生成してみました^[4]。

find ./dist -type f -printf '%s %f\n' \
  | jq -n -R '{name: "dist_size", key: "dist_size", metrics: [inputs | capture("(?<value>\\S+)\\s+(?<key>.+)") + {unit: "byte"} | .value |= tonumber | .name = .key ]}' \
  > dist_js_sizes.json

# 以下のようなJSONが生成される
{
  "name": "dist_size",
  "key": "dist_size",
  "metrics": [
    {
      "value": 1306559,
      "key": "post.js",
      "unit": "byte",
      "name": "post.js"
    },
    {
      "value": 55,
      "key": "main.js",
      "unit": "byte",
      "name": "main.js"
    }
  ]
}

実際に js のサイズに差分が生じるような pull-req を試してみた結果がこちらです。TypeScript 側の修正に合わせて js のサイズも増えたことが分かりやすいですね。

本項の執筆者: @Kesin11

tool 🔨

Release v4.5.0 · suzuki-shunsuke/tfcmt

Terraform の CI 体験を向上させる CLI ツールである tfcmt が v4.5.0 をリリースしました。
terraform v1.5.0 で追加された import ブロックと moved ブロックについても表示できるようになった、ということだと思われます。

新しい機能に追従してアップデートしてくれていて、とてもありがたいです。

本項の執筆者: @r4mimu

あとがき

合併号でした。いやー、前回に引き続きインターンの第二ターム受け入れがあった関係でだいぶ遅くなってしまいました。
やはり 2 週間分のネタがあると大変ボリューミーですね。

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

脚注

GitHub Actions の actions-runner-controller の Autoscaling Runner Scale Sets mode を試す ↩︎
そもそも scale sets モードに触れている記事をほぼ見ませんが... ↩︎
JavaScript の GitHub Actions は node_modules の依存ライブラリも含めて 1 つの.js にバンドルする必要があるため、コードサイズが大きくなりがちです。 ↩︎
jq による JSON の生成コマンドについて当初は --arg や --argjson を使用する拙いものだったのですが、社内の分報にて Professional of jq である@itchynyさんにアドバイスを頂き、capture を使ったワンライナーに改善できました。ありがとうございました！ ↩︎

GitHubで編集を提案

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

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

Productivity Weekly (2023-09-13号, 2023-09-06号)

news 📺

⚠️ Node.js 16 is now end of life, please upgrade to Node.js 18.

The OpenTF fork is now available!

actions/create-github-app-token: GitHub Action for creating a GitHub App Installation Access Token

Bun 1.0 | Bun Blog

マイクロソフト、お客様向けの Copilot Copyright Commitment を発表 - News Center Japan

Dual Static IP ranges for GitHub-hosted Larger runners - The GitHub Blog

Organization Archiving general availability - The GitHub Blog

Change your theme | Confluence Cloud | Atlassian Support

Built-in port forwarding | Visual Studio Code August 2023

know-how 🎓

Actions Runner Controller Deep Dive！ - APC 技術ブログ

octocov で任意のメトリクスを記録できるようにした（カスタムメトリクス） - Copy/Cut/Paste/Hatena

tool 🔨

Release v4.5.0 · suzuki-shunsuke/tfcmt

read more 🍘

あとがき

Discussion