CircleCI 上で Snapcraft を使用した Snap パッケージのビルドとパブリッシュ

Snap とは、複数の Linux ディストリビューション (distros) 上でソフトウェアを迅速にパブリッシュできるパッケージ形式です。 CircleCI を使用して Snap パッケージをビルドし、Snap Store にパブリッシュする方法について説明します。

概要

.snap ファイルを一度作成すれば、snapd をサポートする Ubuntu、Debian、Fedora、Arch などの任意の Linux ディストリビューション上にインストールできます。 Snapcraft 自体の詳細については、Snapcraft の Web サイトを参照してください。

CircleCI 上で行う Snap のビルドは、ローカルマシンの場合とほぼ同じで、CircleCI 2.0 構文でラップされています。ここでは、CircleCI を使用して Snap パッケージをビルドし、Snap Store にパブリッシュする方法について説明します。各セクションでは .circleci/config.yml のサンプルファイルのスニペットを使用しています。サンプルファイルの全体は最後のセクションで確認してください。

前提条件

任意の環境 (ローカル、企業サーバー CI など) で Snap をビルドするには、Snapcraft 設定ファイルが必要です。通常、snap/snapcraft.yml に格納されています。ここでは、このファイルが既に存在し、ローカルマシンで Snap を正しくビルドできると想定します。そうでない場合は、Snapcraft のドキュメントを参照して、ローカルマシンで Snap をビルドしてください。

ビルド環境

#...
version: 2
jobs:
  build:
    docker:
      - image: cibuilds/snapcraft:stable
#...

cibuilds/snapcraft Docker イメージと共に docker Executor が使用されています。このイメージは、Canonical による公式の snapcore/snapcraft Docker イメージをベースとしており、CI 環境へのインストールが推奨されるすべてのコマンドラインツールを備えています。また、実際の Snap のビルドに使用される snapcraft コマンドが含まれています。

Snapcraft の実行

...
    steps:
      - checkout
      - run:
          name: "Snap のビルド"
          command: snapcraft
...

CircleCI で実際に Snap をビルドするために必要なコマンドはこれだけです。これによって Snapcraft が実行され、すべてのビルドステップが実行されて、.snap ファイルが生成されます。通常、このファイルの形式は <snap-name>-<snap-version>-<system-arch>.snap です。

テスト

コードの単体テストについては、CircleCI のブログやドキュメントで詳しく説明されているため、ここでは取り上げません。 Snap をビルドする前に、プロジェクト依存関係、何らかの事前チェック、テスト、コンパイルをプルする job の作成が必要になる場合もあるでしょう。

CircleCI で Snap をビルドすると、.snap ファイルが作成され、このファイルを作成したコードに加えて、このファイルをテストできます。 Snap 自体のテスト方法はユーザーに任されており、一部のユーザーは、さまざまなディストリビューションに Snap をインストールした後、コマンドを実行してインストールプロセスが機能することを確認しています。 Snapcraft は、広範なテストを実行できる Builder フリートを提供しています。これを使用して、コード自体をテストした後に、さまざまなディストリビューションで Snap をテストできます。詳細については、こちらを参照してください。

パブリッシュ

Snap のパブリッシュは、ほぼ 2 ステップで完了します。以下に Linux マシン上の例を示します。

snapcraft login
# プロンプトに従って Ubuntu One のアカウントでログインします
snapcraft export-login snapcraft.login
base64 snapcraft.login | xsel --clipboard

ローカルマシンで、CircleCI にアップロードする Snapcraft の「ログインファイル」を作成します。ローカルマシン上に既にこれらのツールがインストールされており、Snap Store (snapcraft login) にログインしている場合は、snapcraft export-login snapcraft.login コマンドを使用して、snapcraft.login という名前のログインファイルを作成します。このファイルをパブリックに公開したり、Git リポジトリに格納したりはせず、base64 でエンコードして、$SNAPCRAFT_LOGIN_FILE という名前のプライベート環境変数に格納します。

メモ: Snapcraft ログインファイルの有効期限はデフォルトで 1 年間です。認証ファイルの有効期間を延長したい場合は、--expires フラグで有効期限の日付を設定してください。
```
 ...
       - run:
           name: "ストアへのパブリッシュ"
           command: |
             mkdir .snapcraft
             echo $SNAPCRAFT_LOGIN_FILE | base64 --decode --ignore-garbage > .snapcraft/snapcraft.cfg
             snapcraft push *.snap --release stable
 ...
```
base64 エンコードバージョンのファイルを CircleCI にプライベート環境変数として格納したら、ビルド内でそれを使用して、ストアに自動的にパブリッシュすることができます。

この例では、Snapcraft が自動的に .snapcraft/snapcraft.cfg 内のログイン認証情報を検索し、前に作成した環境変数がその場所にデコードされます。次に、snapcraft push コマンドを使用して .snap ファイルを Snap Store にアップロードします。

アップロードとリリース

デフォルトの snapcraft push *.snap は、Snap を Snap Store にアップロードし、サーバー側でストアチェックを実行してから停止します。この Snap は「リリース」されません。すなわち、このアップデートは自動的にはユーザーに表示されません。 Snap をローカルにパブリッシュするには、snap release <release-id> コマンドを使用するか、Snap Store にログインしてリリースボタンをクリックします。

通常の CircleCI の方式では、--release <channel> フラグを使用することで、(上の例のように) 完全に自動化できます。これによって Snap がアップロードされ、ストア側の検証が行われてから、指定したチャンネルに Snap が自動的にリリースされます。

ワークフロー

複数のジョブを使用して、Snap ビルドをさらにうまく構成することができます。実際のプロジェクトをビルド・コンパイルするジョブ、Snap 自体をビルドするジョブ、および Snap (および他のパッケージ) を master 上にのみパブリッシュするジョブはどれも有用です。

ワークフローを使用して、次の 2 つの方法で Snap をビルドできます。

Snap Store チャンネル - 前のセクションで説明したように、ストアにアップロードするときに、オプションで同時にリリースすることが可能です。これにより、CircleCI 上の特定のジョブで特定の Snap チャンネルにデプロイするように指定できます。たとえば、master ブランチを使用して edge チャンネルにデプロイし、タグ付きリリースを使用して stable チャンネルにデプロイできます。
並列パッケージ化 - Snap 以外に flatpak、.deb、.apk などとしてもパッケージ化されるソフトウェアの場合は、各パッケージタイプをそれぞれのジョブに置き、すべてを並列に実行することができます。これにより、Snap が完了するまで .deb パッケージを開始できないなどのケースに比べ、はるかに高速にビルドを完了できます。

生成された Snap ファイルをジョブ間で利用するには、必要に応じて CircleCI の workspaces を使用します。次は、「送信元」ジョブのスニペットと「送信先」ジョブのスニペットを示します。

... # 既に Snap が存在するジョブから
      - persist_to_workspace:
          root: .
          paths:
            - "*.snap"
... # Snap が必要なジョブへ
      - attach_workspace:
          at: .
...

以下に、CircleCI 上で Snap パッケージをビルドするサンプルファイルの全体を示します。これと同じプロセスが [CircleCI ローカル CLI][local-cli-repo] 用の Snap パッケージのビルドに使用されています。

サンプル設定ファイルの全文

version: 2
jobs:
  build:
    docker:
      - image: cibuilds/snapcraft:stable
    steps:
      - checkout
      - run:
          name: "Snap のビルド"
          command: snapcraft
      - persist_to_workspace:
          root: .
          paths:
            - "*.snap"

  publish:
    docker:

      - image: cibuilds/snapcraft:stable
    steps:
      - attach_workspace:
          at: .
      - run:
          name: "ストアへのパブリッシュ"
          command: |
            mkdir .snapcraft
            echo $SNAPCRAFT_LOGIN_FILE | base64 --decode --ignore-garbage > .snapcraft/snapcraft.cfg
            snapcraft push *.snap --release stable


workflows:
  version: 2
  main:
    jobs:

      - build
      - publish:
          requires:
            - build
          filters:
            branches:
              only: master