Orb の手動オーサリングプロセス

4 weeks ago • 1 min read

Cloud

ここでは、Orb 開発キットを使わずにシンプルな Orb を手動で作成する手順について説明します。 ただし、ほとんどの Orb プロジェクトでは、Orb 開発キットのご利用をおすすめします。 詳細は、Orb のオーサリングプロセスを参照してください。

1. まだ名前空間を作成していない場合は、次のコマンドでユーザー/組織の名前空間を作成します。 希望する名前空間と GitHub 組織名を入力して実行してください。

   circleci namespace create <my-namespace> github <my-gh-org>
   

   注: CircleCI CLI から名前空間を作成する場合は、必ず VCS プロバイダーを指定してください。

2. 名前空間内に Orb を作成します。 この段階では Orb のコンテンツは何も生成されませんが、Orb をパブリッシュするときために名前が予約されます。 CircleCI Server をご利用の場合は、--private フラグが使われており、Orb がインストール環境内でプライベートになっていることを確認してください。 **パブリック Orb を作成する場合:</li> </ol>

   circleci orb create <my-namespace>/<my-orb-name>
   

   プライベート Orb を作成する場合:

   circleci orb create <my-namespace>/<my-orb-name> --private
   

3. YAML ファイル形式で Orb のコンテンツを作成します。 以下のシンプルな例を参考にしてください。

   version: 2.1
   description: あいさつコマンド Orb
   commands:
    greet:
        description: 相手に "Hello" とあいさつします。
        parameters:
            to:
                type: string
                default: World
        steps:
            - run: echo "Hello, << parameters.to >>"
   

4. CLI を使用して、Orb コードをバリデーションします。

   circleci orb validate /tmp/orb.yml
   

5. 開発版の Orb をパブリッシュします。

   circleci orb publish /tmp/orb.yml <my-namespace>/<my-orb-name>@dev:first
   

6. Orb を安定版にプッシュする準備が整ったら、circleci orb publish を使用して手動でパブリッシュするか、開発版から直接プロモートすることができます。 以下のコマンドを使用すると、開発版のバージョン番号を 0.0.1 にインクリメントできます。

   circleci orb publish promote <my-namespace>/<my-orb-name>@dev:first patch
   

7. 安定版の Orb が変更不可形式でパブリッシュされ、CircleCI プロジェクトで安全に使用できるようになりました。 以下のコマンドを使用して、Orb のソースをプルします。

   circleci orb source <my-namespace>/<my-orb-name>@0.0.1
   

8. CLI を使用して、公開中の Orb を一覧表示します。

パブリック Orb を一覧表示する場合:

circleci orb list <my-namespace>

プライベート Orb を一覧表示する場合:

circleci orb list <my-namespace> --private

circleci orb コマンドの使用方法の詳細については、CLI に関するドキュメントを参照してください。

---

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

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

• このページの編集をご提案ください (最初に「コントリビューションガイド」をご覧ください)。
• ドキュメントの問題点を報告する、またはフィードバックやコメントを送信するには、GitHub で issue を作成してください。
• CircleCI は、ユーザーの皆様の弊社プラットフォームにおけるエクスペリエンスを向上させる方法を常に模索しています。 フィードバックをお寄せいただける場合は、リサーチコミュニティにご参加ください。

サポートが必要ですか？

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

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

---

CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.