CircleCI コンフィグ SDK
1+ year ago1 min read
クラウド
このページの内容
概要
CircleCI コンフィグ SDK は、CircleCI YAML 設定ファイルを生成するための (TypeScript とも互換性のある) JavaScript パッケージライブラリです。 この SDK は次の目的で使用します。
-
YAML 設定ファイルを書き換える
-
静的な YAML 設定ファイルを生成する
-
設定を JavaScript パッケージとしてモジュール化し、管理する
-
CircleCI の ダイナミックコンフィグ を高度化する
-
CLI やブラウザベースのツールとのインテグレーション
例えば、CLI ツールや ビジュアルコンフィグエディター などのブラウザベースのツールを使用して、静的な設定ファイルを作成することができます。
CircleCI コンフィグ SDK で作成されたコンポーネントは、Node パッケージとしてパッケージ化し、配布できます。
SDK のインストール
CircleCI コンフィグ SDK は、NPM または Yarn を使用してインストールし、Node.js またはブラウザーを使ってプロジェクトに含めます。
NPM を使用したインストール:
$ npm i @circleci/circleci-config-sdkYarn を使用したインストール:
yarn add @circleci/circleci-config-sdkNode.js を使用する場合:
import CircleCI from '@circleci/circleci-config-sdk';ブラウザーを使用する場合:
const CircleCI = require('@circleci/circleci-config-sdk');SDK のページにアクセスして、CircleCI 設定ファイル作成の 設定例の完全版 をご覧ください。
開発へのご協力のお願い
CircleCI コンフィグ SDK はオープンソースであり、いつでも開発へのご参加をお待ちしております。 ガイドラインとリリースプロセスについては、 コントリビューションガイド をご覧ください。