Nerves System の互換表を自動生成するスクリプト

はじめに

以前 Nerves 公式ドキュメントに掲載されている Nerves System の互換表 についてご紹介させていただきました。
今回は、その互換表がどのように作成されているのかを解説したいと思います。

Nerves System 互換表 とは？

各 Nerves System の対応バージョン（Elixir, OTP, Linux, etc.）を一覧で確認できる互換表です。

nerves_system_compatibility.exs スクリプト とは？

このスクリプトの主な役割は、Nerves 公式リポジトリからシステム情報を収集し、各リリースの詳細情報（バージョン情報、依存関係など）を解析して、互換表 に必要なデータを出力形式に整形することです。このスクリプトをもちいることで、互換表 の更新が効率的に行えます

データの取得元

以下に、nerves_system_compatibility.exs スクリプトが各データを収集する際の具体的な参照元を示します。

Elixir/OTP バージョン

収集方法

各 Nerves System のリポジトリでバージョンごとに mix.exs をチェックアウトし、:nerves のバージョンを解析して Elixir/OTP の互換性を確認します。

get_nerves_version_for_target/2 関数を使用して、以下のように mix.exs からバージョン情報を取得します：

def get_nerves_version_for_target(target, version) do
  cd = "#{@download_dir}/nerves_system_#{target}"
  cmd = "cd #{cd} && git checkout v#{version} > /dev/null 2>&1 && grep :nerves, mix.exs"
  ...
end

Linux カーネルバージョン

収集方法

nerves_system_br のバージョンを特定し、それに基づいてリポジトリ内の設定ファイル nerves_defconfig から Linux カーネルバージョンを取得します。

get_linux_version_for_target/2 関数を用いてバージョン情報を取得します。

def get_linux_version_for_target(target, version) do
  cd = "#{@download_dir}/nerves_system_#{target}"
  cmd = "cd #{cd} && git checkout v#{version} > /dev/null 2>&1 && cat nerves_defconfig"
  ...
end

Buildroot バージョン

収集方法

nerves_system_br のリポジトリから create-build.sh スクリプトや設定ファイルを解析して Buildroot バージョンを特定します。

get_buildroot_version/1 関数が以下のように機能します。

def get_buildroot_version(nerves_system_br_version) do
  cd = "#{@download_dir}/nerves_system_br"
  cmd = "cd #{cd} && git checkout v#{nerves_system_br_version} > /dev/null 2>&1 && grep NERVES_BR_VERSION create-build.sh"
  ...
end

OTP バージョン

収集方法

.tool-versions ファイル、Dockerfile、またはパッチファイルから OTP バージョンを解析します。特定の nerves_system_br バージョンに応じて異なる解析手法が適用されます。

以下はget_otp_version_from_nerves_system_br_tool_versions/1 関数で.tool-versions ファイルから OTP バージョンを取得する例です。

def get_otp_version_from_nerves_system_br_tool_versions(nerves_system_br_version) do
  cd = "#{@download_dir}/nerves_system_br"
  cmd = "cd #{cd} && git checkout v#{nerves_system_br_version} > /dev/null 2>&1 && cat .tool-versions"
  ...
end

おわりに

このnerves_system_compatibility.exsスクリプトは、Nerves プロジェクトに貢献するために作成しました。

特に、Nerves プロジェクトのコアチームがNerves System の互換表を効率的に更新するための内部ツールとして役立っています。スクリプトを使うことで、正確で最新の情報を簡単に収集・整理できる仕組みを提供しています。

何か氣づいた点や改善のアイデアがあれば、お便りいただけると嬉しいです。