Orb オーサリングの概要
クイックスタート
Orb とは、 再利用可能な設定をパッケージとしてまとめたものです。 Orb は Orb レジストリにパブリッシュしたり、複数の設定ファイルにインポートすることができます。 類似した複数のプロジェクトを管理する場合に、Orb を使って設定を抽象化してみましょう。
Orb のオーサリングを始める前に、まず CircleCI の設定ファイルに関するページと、 パラメーター化された再利用可能な設定要素のオーサリングに関するページの説明をよく理解することをお勧めします。
Orb は、以下の 3 つの要素で構成されます。
インライン Orb を使って練習してみましょう。 インライン Orb は 1 つの設定ファイル内で定義できるので、手早く簡単にテストできます。
はじめよう
Orb CLI
Orb の作成を始めるには、 パーソナル アクセス トークンを使用して、ローカル マシンに CircleCI CLI をセットアップする必要があります。 CircleCI CLI のすべてのヘルプ コマンドは、 CircleCI CLI ヘルプで参照できます。
権限の一覧表
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> --org-id <your-organization-id>
注: 組織 ID の見つけ方については、 CircleCI Web アプリの概要のページをご覧ください。
次のステップ
- Orb の作成について解説した Orb オーサリング プロセス ガイドに進んでください。
- または、 Orb のコンセプトのページで詳細をご確認下さい。
ドキュメントの改善にご協力ください
このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、 GitHub でご利用いただけます。 ご協力いただき、ありがとうございます。
- このページの編集をご提案ください (最初に「コントリビューションガイド」をご覧ください)。
- ドキュメントの問題点を報告する、またはフィードバックやコメントを送信するには、GitHub で issue を作成してください。
- CircleCI は、ユーザーの皆様の弊社プラットフォームにおけるエクスペリエンスを向上させる方法を常に模索しています。 フィードバックをお寄せいただける場合は、リサーチコミュニティにご参加ください。
サポートが必要ですか
CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。
または、 サポートサイト から、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.