ドキュメント
circleci.com
Start Building for Free

Orb の概要

1 month ago1 min read
クラウド
Server v3.x
On This Page

Orb は、再利用可能なコードスニペットです。Orb を使用すると、繰り返しのプロセスを自動化でき、手早くプロジェクトをセットアップできます。サードパーティ製ツールとの連携も容易になります。 CircleCI Developer Hub の CircleCI Orb レジストリでは、設定作業の簡素化に役立つ Orb を検索できます。

Orb に含まれる再利用可能なスニペットは、たとえば ジョブ コマンド Executor 、および Node.js やそのパッケージマネージャーなどです。

Orb を使用すると、設定がシンプルになり、ソフトウェアやサービススタックとの連携を多くのプロジェクトにまたがって素早く容易に行えるようになります。

ご自身の Orb をオーサリングする場合は、 Orb のオーサリング方法のページをご覧ください。

Orb を使用するメリット

Orb では設定ファイルの要素をパラメーター化できるため、設定を大幅に簡素化できます。 例を使って説明しましょう。以下は、Node.js アプリケーションをテストするための一般的な設定ファイルであり、ジョブの定義には、アプリケーションのテストに必要なステップが複数含まれています。一方、CircleCI Orb を使用する場合は、 circleci/node Orb に含まれる test ジョブを使用します。 Orb を使用すれば、パラメーター化された設定を 1 回記述するだけで、それをいくつもの類似したプロジェクトで利用できるようになります。

Orb レジストリ

Orb レジストリは、パブリッシュされたすべての Orb が掲載されたオープンリポジトリです。 自分のスタックに適した Orb を検索できるだけでなく、 独自の Orb を開発してパブリッシュすることもできます。

Orb レジストリ

レジストリの Orb には、次の 3 つのラベルのいずれかが表示されます。

CertifiedWritten and tested by the CircleCI team PartnerWritten by our technology partners CommunityWritten by the community

それぞれの Orb には、Orb レジストリにリストされている説明とドキュメントが含まれています。 多くの場合、Orb には参考になる使用例が記載されています。

多くの Orb オーサーが Git リポジトリのリンクを掲載しており、既存の Orb に貢献したり、Orb リポジトリに関する問題を報告することができます。

パブリックまたはプライベート

Orb は以下のいずれかの方法でパブリッシュすることができます。

  • パブリック: Orb レジストリで検索でき、誰でも使用できます。
  • プライベート: 組織内でのみ使用することができ、直接 URL を使って認証されている場合のみレジストリ内で表示されます。

Orb の概要のページの パブリック Orb vs プライベート Orb を読み、これらの概念をご理解ください。

Orb の指定

Orb は、_名前空間_と _Orb 名_から成る_スラッグ_で指定します。 名前空間は、Orb をオーサリングした組織を指す一意の識別子です。 Orb 名の後には、@ 記号と、使用する Orb バージョンを指定する セマンティック バージョン文字列が続きます。

Orb スラッグの例: <namespace>/<orb-name>@1.2.3

Orb の使用

レジストリで公開されている Orb には、その Orb の最新バージョンをインポートするためのサンプルコード スニペットが用意されています。

以下の例に、version: 2.1 の設定ファイルに Orb をインポートする方法を示します。 orbs キーの後に、インポートする Orb を表す orb-name キーを記述します。 orb-name キーの値には、Orb スラッグとバージョンを指定します。

version: 2.1

orbs:
  orb-name: <namespace>/<orb-name>@1.2.3

設定ファイルに Orb をインポートしたら、その Orb が提供するエレメントを <orb-name>/<element> の形式で使用できます。 Orb エレメントは、 再利用可能な設定要素と同じ方法で使用できます。 Orb のコマンドの使用方法について詳しくは、下記の Node の例をご覧ください。

Node の例

Node Orb には、 install-packages という Node パッケージをインストールしてキャッシュを自動的に有効にするコマンドがあります。このコマンドには、パラメーターを使用して追加のオプションを指定できます。 install-packages コマンドを使用するには、ジョブの steps にこのコマンドを記述します。

version: 2.1

orbs:
  node: circleci/node@x.y #orb バージョン

jobs:
  test:
    docker:
      - image: cimg/node:<node-version>
        auth:
          username: mydockerhub-user
          password: $DOCKERHUB_PASSWORD  # コンテキスト / プロジェクト UI 環境変数の参照
    steps:
      - checkout
      - node/install-packages # steps でコマンドを使用する

CircleCI アプリ上の Orb ページ

この Orb のページを読むと、組織が作成した Orb についてよく分かります。 ユーザーはこのページのリストビューで、Orb がパブリックなのかプライベートなのか、Orb の使用状況 (その Orb が全設定ファイルにおいて使用された回数)、最新バージョンや説明を直接確認することができます。

この Orb ページにアクセスするには、アプリの Organization Settings を開きます。

Orb のソースなどの詳しい情報は、Orb の名前をクリックするとアクセスすることができます。 この Orb の詳細ページでは、CircleCI Orb レジストリと同様に、Orb のコンテンツ、コマンド、使用例を紹介しています。 注: プライベート Orb の詳細ページは、ログインしている組織のメンバーのみ閲覧できます。 パブリッシュされていない Orb には詳細ページはリンクされません。

関連項目

詳しく見る

CircleCI Academy の Orb コース を受講すると、さらに詳しく学ぶことができます。


ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。 ご協力いただき、ありがとうございます。

サポートが必要ですか

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、 サポートサイト から、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。