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

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

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

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

  2. 名前空間内に Orb を作成します。 この段階では Orb のコンテンツは何も生成されませんが、Orb をパブリッシュするときの名前が予約されます。 To create a public orb:
    circleci orb create <my-namespace>/<my-orb-name>
    

    パブリック Orb を作成する場合:

    circleci orb create <my-namespace>/<my-orb-name> --private
    
  3. YAML ファイル形式で Orb のコンテンツを作成します。 以下のシンプルな例を参考にしてください。 ```yaml version: 2.1 description: あいさつコマンド Orb commands: greet: description: 相手に “Hello” とあいさつします。 parameters: to: type: string default: World steps: - run: echo “Hello, « parameters.to »” parameters: to: type: string default: World steps: - run: echo “Hello, « parameters.to »”

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

circleci orb validate /tmp/orb.yml


1. 開発版の Orb をパブリッシュします。
```sh
circleci orb publish /tmp/orb.yml <my-namespace>/<my-orb-name>@dev:first
  1. Orb を安定版にプッシュする準備が整ったら、circleci orb publish を使用して手動でパブリッシュするか、開発版から直接プロモートすることができます。 以下のコマンドを使用すると、開発版のバージョン番号を 0.0.1 にインクリメントできます。 ```sh circleci orb publish promote /@dev:first patch

1. 安定版の Orb が変更不可形式でパブリッシュされ、CircleCI プロジェクトで安全に使用できるようになりました。 以下のコマンドを使用して、Orb のソースをプルします。
```sh
circleci orb source <my-namespace>/<my-orb-name>@0.0.1
  1. CLI を使用して、公開中の Orb を一覧表示します。

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

circleci orb list <my-namespace>

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

circleci orb list <my-namespace> --private

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



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

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


クリエイティブ・コモンズ・ライセンス
CircleCICircleCI ドキュメントは、クリエイティブ・コモンズの表示--非営利-継承 4.0 国際ライセンス に基づいてライセンス供与されています。