🌞

Productivity Weekly (2021-08-04号)

11 min read

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

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

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

news 📺

Introduction to heredocs in Dockerfiles - Docker Blog

https://www.docker.com/blog/introduction-to-heredocs-in-dockerfiles/

Docker の BuildKit が Dockerfile 内のヒアドキュメントに対応しました。これまではシェルスクリプトを用意したり && を多用していましたが、これからは楽に綺麗に書けそうです。使うためには docker build 時に BuildKit を使うようにしなければいけません[1]

例えば docker build 時に apt-get install をする際、1 つの RUN でパッケージのインストールからキャッシュの削除までをすることで、イメージサイズを節約するというテクニックがあります[2]

複数コマンドを 1 つの RUN で実行するため、下記のように && などでコマンド同士をつなぐ必要がありました。また、改行して可読性を上げるために \ も多用していました。

今まではこんなふうに複数行にわたるコマンドを書いてた
RUN apt-get update \
 && apt-get install -y \
    curl \
    jq \
 && rm -rf /var/lib/apt/lists/*

対して、ヒアドキュメントが使えるようになると普通のシェルスクリプトを書いているような感覚で Dockerfile を記述できます。

これからはこんなふうに書ける
RUN <<EOF
apt-get update
apt-get install -y \
  curl \
  jq
rm -rf /var/lib/apt/lists/*
EOF

これくらいの量ならそんなに気にならないかもしれませんが、複雑になってくるとなかなか辛くなってくるのでこれは嬉しいです。

さらに、ヒアドキュメントが使えるようになって、以下のように Dockerfile に書いた他言語のスクリプトを実行することも簡単にできるようになりました(しかし、もし複雑なコードを書くならそれはファイルに切り出した方が良いかとは思います。lint などの恩恵も受けられるので)。

DockerfileにPythonなどのコードを簡単に書けるようになった
RUN python3 <<EOF
with open("/hello", "w") as f:
  print("Hello", file=f)
  print("World", file=f)
EOF

2021/08/18 追記

Docker Desktop for Mac v3.6.0 では使えないと記述していたのですが、誤りであったため修正しました。Dockerfile の先頭に # syntax=docker/dockerfile:1.3-labs を追加すれば使えました。僕は間違えて # syntax=docker.io/docker/dockerfile:1.3.0 を追加してしまっていたため使えていませんでした。誤った情報を書いてしまい申し訳ありませんでした。

さっそく実行してみました。Dockerfile の先頭に # syntax=docker/dockerfile:1.3-labs という行を追加することでヒアドキュメントが使えます。(buildkit のバージョンが新しければ無くても動作すると思われます。)

Docker Desktop for Mac v3.6.0 でヒアドキュメントを使った際のログ
食わせたDockerfile
# syntax=docker/dockerfile:1.3-labs

FROM ubuntu

RUN <<EOF
apt-get update
apt-get install -y \
  curl \
  jq
rm -rf /var/lib/apt/lists/*
EOF
Docker Desktop for Mac v3.6.0では使えなかった
❯ docker build .
[+] Building 44.7s (12/12) FINISHED                                                                                                                                    
 => [internal] load build definition from Dockerfile                                                                                                              0.0s
 => => transferring dockerfile: 188B                                                                                                                              0.0s
 => [internal] load .dockerignore                                                                                                                                 0.0s
 => => transferring context: 2B                                                                                                                                   0.0s
 => resolve image config for docker.io/docker/dockerfile:1.3-labs                                                                                                 3.0s
 => [auth] docker/dockerfile:pull token for registry-1.docker.io                                                                                                  0.0s
 => docker-image://docker.io/docker/dockerfile:1.3-labs@sha256:03ca0e50aa4b6e76365fa9a5607c3f988bc9284de6a82672eab5ad627324e1fe                                   0.9s
 => => resolve docker.io/docker/dockerfile:1.3-labs@sha256:03ca0e50aa4b6e76365fa9a5607c3f988bc9284de6a82672eab5ad627324e1fe                                       0.0s
 => => sha256:03ca0e50aa4b6e76365fa9a5607c3f988bc9284de6a82672eab5ad627324e1fe 2.00kB / 2.00kB                                                                    0.0s
 => => sha256:c6afe91d6f5e32ee187adf7516f1ced1d7d2f9621ff4e907ce70323c35a9a375 528B / 528B                                                                        0.0s
 => => sha256:456bbe8ddbe759d5109d4f5bfe8ce105c0086863298fde8bb49a79d3d7e134b3 1.21kB / 1.21kB                                                                    0.0s
 => => sha256:ce897ecde42e8c45c0056748ec1a17a3edc5b7d3b091dae356a488f44ca9394a 9.67MB / 9.67MB                                                                    0.6s
 => => extracting sha256:ce897ecde42e8c45c0056748ec1a17a3edc5b7d3b091dae356a488f44ca9394a                                                                         0.3s
 => [internal] load build definition from Dockerfile                                                                                                              0.0s
 => [internal] load .dockerignore                                                                                                                                 0.0s
 => [internal] load metadata for docker.io/library/ubuntu:latest                                                                                                  1.4s
 => [auth] library/ubuntu:pull token for registry-1.docker.io                                                                                                     0.0s
 => CACHED [1/2] FROM docker.io/library/ubuntu@sha256:82becede498899ec668628e7cb0ad87b6e1c371cb8a1e597d83a47fac21d6af3                                            0.0s
 => [2/2] RUN <<EOF (apt-get update...)                                                                                                                          38.8s
 => exporting to image                                                                                                                                            0.2s
 => => exporting layers                                                                                                                                           0.2s
 => => writing image sha256:a0a8b99d9e4c3e78d79111a6f088bce551910c1bc52c9474e6682cf26c5178b2                                                                      0.0s

https://github.blog/changelog/2021-08-02-apis-for-autolinks/

GitHub の autolinks が REST API に対応しました(ベータ)。

autolinks はプレフィックスと外部システムのリンクを設定しておくことで、自動リンクを生成してくれる機能です(説明が難しい)。詳しくは Configuring autolinks to reference external resources - GitHub Docs を参照。

使用例


例えばプレフィックス HOGE-https://www.google.com/search?q=hoge-<num> に飛ぶように設定すると


HOGE-2020 のようなテキストに自動でリンクが貼られるようになる

kintone や Linear などでタスク管理していると Issue や PR、コミットメッセージにタスクへのリンクを貼りたくなりますが、autolinks を設定しておくことで簡単にタスクへ飛ぶことができてとても便利です。

今回 REST API で autolinks の設定ができるようになりました。これまで autolinks はリポジトリごとに設定する必要がある、かつ、Web UI でしか設定できなかったため、毎回設定するのが面倒でした。API で簡単に自動化できるようになったのでこれからは楽に autolinks を設定できるようになりそうです。

know-how 🎓

Docker Composeの環境変数ではなくsecretsで秘密情報を扱う - Qiita

https://qiita.com/myabu/items/89797cddfa7225ff2b5d

Docker Compose で DB のコンテナなどを扱う際、docker-compose.yaml に環境変数でシークレットを記述する方法があります。この記事では Docker Compose の環境変数で秘密情報を扱う際の問題点と、その解決策として secrets が紹介されています。

secrets は Docker Compose v3.1 から追加された構文で、ローカルのファイルをコンテナ内にマウントする機能です。これを使うことで環境変数を使わずにシークレットをコンテナ内に渡すことができます。

恥ずかしながら僕は secrets のことを知りませんでした。これから使っていきたいと思います。

“生産性向上に投資するため”のデータの可視化 生産性測定から組織の仕組み作りをサポート - ログミーTech

https://logmi.jp/tech/articles/324731

生産性が向上しているかどうかを可視化するための測定方法、仕組み作りを紹介した記事です。

Google が提唱している、ソフトウェア開発チームのパフォーマンスを示すための 4 つの指標(Four Keys)があります。この記事では Four Keys の各指標が対象プロダクト(SUZURI)とどう対応しているか、どうやってメトリクスを抽出したか、可視化してみて今後どういう方針が立てられるかなどが書かれています。

何を持って生産性が向上した考えるかは難しいです。測定方法もプロダクト・チームによって全然違う方法になると思います。この記事は 1 つの事例として生産性向上していく上でとても参考にできそうです。

koneta 🍘

Productivity Weekly で出たネタを全て紹介したいけど体力が持たない、または、そんなに言うことがなかったネタを一言程度で書くコーナーです。

  • Search issues by label using logical OR | GitHub Changelog
    • GitHub の Issues において、ラベルに対して OR 検索ができるようになりました。
    • 区切りにはカンマ , を使います。例えば label:"good first issue",bug と検索すると、good first issue または bug のラベルが付いた Issue を検索できます。
    • 試してみたところ、ラベル以外にも利用できることがわかりました。例えば is:issue,pr とすると Issue と Pull Request の両方を検索できます。(以前からカンマ区切りで OR 検索できた?)
  • 受け入れテストを日本語で書ける Jest 拡張 "Jest-gauge" を公開しました
    • 受け入れテストを Markdown 形式の自然言語で書くためのテストフレームワーク Gauge を Jest で使うための拡張 Jest-gauge を作ったという記事です。
    • 受け入れテスト駆動開発について、なぜ Gauge か、なぜ Jest-gauge かなどが述べられています。
    • 小ネタにするか迷ったのですが、まだ開発途中であること、かつ、2 ヶ月ほどリポジトリの更新がなさそうだったことから小ネタにしました。
  • Stack Overflow Developer Survey 2021
    • Stack Overflow のデベロッパーサーベイ 2021。
    • 多く使われている言語や DB、フレームワーク以外にも何年選手かや性別なんかも調査結果がある
    • 個人的に面白かったのが最も愛されてる言語と最も恐れられてる言語一覧。COBOL が最も恐れられている。

あとがき

投稿がめちゃくちゃ遅くなってしまいすみませんでした。生産性向上コースのインターンを開催していたのと、その後のお盆に夏休みをとっていたことから遅くなってしまいました。

そうです。生産性向上コースで初のインターンシップを開催しました。色々と準備不足が見つかったりしてなかなか大変でしたが、インターン生が楽しく参加できていたっぽくて良かったです。僕たちメンターも楽しかったですね。実は生産性向上コースのインターンは 2 週間後にもう 1 回あるので、更なる準備をしてもう 1 回のインターンに臨みたいですね。

生産性向上チームでは毎週こういったネタを共有する会を行っています。そんな生産性向上チームが気になる方は下のリンクをクリック!

https://blog.cybozu.io/entry/2020/08/31/080000

今週のおまけはお休みです

脚注
  1. 環境変数に DOCKER_BUILDKIT=1 を設定しましょう ↩︎

  2. 「In addition, when you clean up the apt cache by removing /var/lib/apt/lists it reduces the image size, since the apt cache is not stored in a layer. Since the RUN statement starts with apt-get update, the package cache is always refreshed prior to apt-get install.」(参考↩︎

Discussion

ログインするとコメントできます