Orb オーサリングの概要

クイックスタート

Orb とは、再利用可能な構成をパッケージとしてまとめたものです。Orb は Orb レジストリにパブリッシュしたり、複数の設定ファイルにインポートしたりすることができます。 類似した複数のプロジェクトを管理する場合に、Orb を使って構成を抽象化することを検討してみてください。

Orb のオーサリングを始める前に、まず CircleCI の設定ファイルに関するページと、パラメーター化された再利用可能な構成要素のオーサリングに関するページの説明をよく理解することをお勧めします。

Orb は、以下の 3 つの要素で構成されます。

インライン Orb を使って練習してみることができます。 インライン Orb は 1 つの設定ファイル内で定義できるので、手早く簡単にテストするのに適しています。

Orb をオーサリングすると、自動的に、CircleCI コード共有利用規約に同意したものと見なされます。 パブリッシュされたすべての Orb は、MIT ライセンス契約に基づき、Orb レジストリで公開されます。 詳細については、Orb ライセンスに関するページをご覧ください。

はじめよう

Orb CLI

Orb の作成を始めるには、パーソナル アクセス トークンを使用して、ローカル マシンに CircleCI CLI をセットアップする必要があります。 CircleCI CLI ヘルプにアクセスすると、CircleCI CLI に含まれている Orb 関連のすべてのコマンドが記載されたリストを確認できます。

権限の一覧表

Orb CLI のコマンドは、VCS (バージョン管理システム) によって、ユーザーの権限レベルごとに異なる範囲が設定されています。 組織の「オーナー」は、オーサリングを行うユーザー自身です。 別の組織がオーナーである名前空間向けに Orb のオーサリングやパブリッシュを行う際は、組織の管理者への支援要請が必要になる場合があります。

Orb コマンド 権限の範囲
circleci namespace create オーナー
circleci orb init オーナー
circleci orb create オーナー
circleci orb publish 開発バージョン メンバー
circleci orb publish 本番バージョン オーナー

名前空間の登録

CircleCI に登録している組織は、一意の名前空間1 つ要求できます。 「組織」には、自分の個人用組織や自分がメンバーになっている組織が含まれます。 名前空間は各組織に 1 つに制限されているため、組織の名前空間を登録するには、自分が組織の オーナー になっている必要があります。

まだ名前空間を要求していない場合は、以下のコマンドを実行して要求できます。

circleci namespace create <name> <vcs-type> <org-name> [flags]

次のステップ

Orb の作成について解説した Orb オーサリング プロセス ガイドに進んでください。

関連項目