てくなべ (tekunabe)

ansible / network automation / 学習メモ

[Ansible] 公式ドキュメントの更新状況を追う

この記事は、Ansible Advent Calendar 2022 (Adventar 版) の 19日目の記事です。

はじめに

Ansible の公式ドキュメントは、GitHubリポジトリ ansible/ansible 上で追加や修正されています。

devel ブランチのコミットを追っても分かるといえば分かるのですが、もちろんコードの修正も入るので、ドキュメントの更新だけを追いたい場合はや不向きかと思います。

私がたまに更新状況を追っているのですが、そのときにやっていることをまとめます。

方法1: docs タグがついたプルリクエストを追う

ドキュメントを更新するプルリクエストを送ると bot によって、docs というタグが自動的で付きます()。

なので、docs タグが付いたプルリクエストを追ってくと更新状況を追えます。

方法2: Backportapalooza のプルリクエストを追う

方法1 のプルリクエストを個別に追っていくのは、細かい修正を含むためちょっと大変なときがあります。

そんなときに便利なのが、Backportapalooza のプルリクエストを追う方法です。

Backportapalooza は、月に数回行われている 複数のドキュメント更新のバックポートのプルリクエストが出されるときにつくタイトルです。バックポートというのは、開発ブランチである devel にマージされたプルリクエストを、以前の stable ブランチ(stable-2.14 など) にも、ある種さかのぼって反映させる行為です。

たぶんですが、末尾の apalooza は 〜祭りのニュアンスかなと思います。まとめで出す「バックポート祭り」という感じでしょうか。特に公式で定められてる作法でもなさそうで、最近特定の方によって行われているように見えます。以前は一人ひとりが必要に応じてバックポートを出していましたが、まとめて出してくださって助かっています。

以下が例です。

github.com

上記の例では、説明にある通り 8つの プルリクエストをまとめてバックポートしています。

それぞれのプルリクエストを確認すると、何の更新かが分かります。

それか、ファイルの更新一覧(今回の場合はこちらから)をざっと眺めます。

なお、Backportapalooza のプルリクエストにも docs タグがつくので、方法1のときに出会うときもあります。

おわりに

ドキュメントの更新を追う時に私がやっている方法をまとめました。参考になれば幸いです。