CircleCI コンフィグ SDK

クラウド

概要

CircleCI コンフィグ SDK は、CircleCI YAML 設定ファイルを生成するための (TypeScript とも互換性のある) JavaScript パッケージライブラリです。この SDK は次の目的で使用します。

例えば、CLI ツールやビジュアルコンフィグエディターなどのブラウザベースのツールを使用して、静的な設定ファイルを作成することができます。

CircleCI コンフィグ SDK で作成されたコンポーネントは、Node パッケージとしてパッケージ化し、配布できます。

CircleCI コンフィグ SDK は、NPM または Yarn を使用してインストールし、Node.js またはブラウザーを使ってプロジェクトに含めます。

NPM を使用したインストール:

$ npm i @circleci/circleci-config-sdk

Yarn を使用したインストール:

yarn add @circleci/circleci-config-sdk

Node.js を使用する場合:

import CircleCI from '@circleci/circleci-config-sdk';

ブラウザーを使用する場合:

const CircleCI = require('@circleci/circleci-config-sdk');

SDK のページにアクセスして、CircleCI 設定ファイル作成の設定例の完全版をご覧ください。

CircleCI コンフィグ SDK はオープンソースであり、いつでも開発へのご参加をお待ちしております。ガイドラインとリリースプロセスについては、コントリビューションガイドをご覧ください。

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

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

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

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