Orbs とは

CircleCI Orbs は、ジョブ、コマンド、Executor のような設定要素をまとめた共有可能なパッケージです。 CircleCI 独自の認証済み Orbs のほか、パートナー企業によるサードパーティ製 Orbs を用意しています。 Workflow の設定をする際には、まずはそれら既存の Orbs のなかに活用できるものがないかチェックしてみることをおすすめします。 認証済みの Orbs は CircleCI Orbs レジストリで一覧を確認できます。

Orb をインポートする

既存の Orb をインポートするには、version 2.1 の .circleci/config.yml ファイルで、下記のように 1 つの Orb につき設定を 1 行書き加えます。

version: 2.1

orbs:
  slack: circleci/slack@0.1.0
  heroku: circleci/heroku@0.0.1

この例では、設定に Slack orb と Heroku orb という 2 つの Orbs がインポートされます。

注 : CircleCI 2.1 以前のバージョンで作成されたプロジェクトでは、Enable build processing を ON にすることで Orbs キーを使えるようになります。

独自に Orb を作成する

既存の Orbs のなかに目的に合うものが見つからないときは、下記の circleci orb help コマンドの結果で示されている通り、CircleCI CLI 上で自身の環境や設定要件を満たす独自の Orb を作成できます。 既存の Orb をインポートするのに比べて時間はかかってしまいますが、新たに作成したものは世界中のユーザーに使ってもらえる Orb として公開できます。

nohighlight
$ circleci orb help
Operate on orbs

Usage:
  circleci orb [command]

Available Commands:
  create      Create an orb in the specified namespace
  list        List orbs
  process     Validate an orb and print its form after all pre-registration processing
  publish     Publish an orb to the registry
  source      Show the source of an orb
  validate    Validate an orb.yml

注 : Orb の作成時においては、CircleCI の設定画面でサードパーティ製 Orb の利用と作成に関するオプトインをあなたの所属組織が承諾した段階で、あなたが CircleCI のコード共有利用規約に同意したとみなされます。 これにより、すべての Orbs は MIT ライセンスの元、CircleCI がユーザーに利用を許諾する形となります。

パートナー製 Orbs をインポートする

パートナー製の Orbs をインポートするには、.circleci.yml/config.yml ファイル内で orbs キーを指定し、<orb 参照文字列> を下記の一覧から選んだ文字列と置き換えます。

version: 2.1

orbs:
  <orb 参照文字列>

注 : あなたの組織でサードパーティ製 Orbs を利用するにあたっては、あらかじめ CircleCI の Settings ＞ Security ページにアクセスし、[Orb Security Settings] で [Yes] を選んでおく必要があります。

関連情報

• 既存の Orbs の使い方については「Orbs を使用する」をご覧ください。
• 新たに Orb を作成する詳しい手順は「Orbs を作成する」をご覧ください。
• 一般的な質問に対する答えをお探しの場合は「Orbs に関する FAQ 」をご覧ください。
• 再利用が可能な Orbs、コマンド、パラメータ、Executors の詳しい例については「コンフィグを再利用する」をご覧ください。
• 作成した Orb のテスト方法については、Orbs をテストする で詳しく解説しています。
• Orbs 利用時の法的条件に関する詳細については「Orbs レジストリ」をご覧ください。