CircleCI 配置 SDK

3⁄4 ̄ ̧漯B

这种回波不再由CircleCI维护,支持或监控. 后90天将存档. 对于那些想继续使用它的人来说,这可以成为借口.

这种SDK是在 " 现成 " 和 " 现成 " 的基础上提供的,没有任何保证。 CircleCI否认所有明示或默示的担保,包括但不限于所有默示的可商性、所有权、适合某一特定目的和不侵权的担保.

创建和管理您的 圆CI 带有 JavaScript 的配置文件 类型脚本 .

目录

• CircleCI 配置 SDK
  • 目录
  • 开始
    • 安装
      • 使用量
    • 示例
  • 获取帮助
    • 资源
• 捐款
• 相关

开始

📖 开始维基

📖 SDK API 文档

💻 实例

安装

使用 npm :

$ npm i @circleci/circleci-config-sdk

使用线条 :

$ yarn add @circleci/circleci-config-sdk

使用量

在浏览器中:

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

在节点.js中:

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

示例

使用 TypeScript/ Javascript 生成 CircleCI 配置, 并正确输入为完整 英特利斯纳支持.

const CircleCI = require('@circleci/circleci-config-sdk');
// Instantiate new Config
const myConfig = new CircleCI.Config();
// Create new Workflow
const myWorkflow = new CircleCI.Workflow('myWorkflow');
myConfig.addWorkflow(myWorkflow);

// Create an executor instance
// Executors are used directly in jobs
// and do not need to be added to the config separately
const nodeExecutor = new CircleCI.executors.DockerExecutor('cimg/node:lts');

// Create Job and add it to the config
const nodeTestJob = new CircleCI.Job('node-test', nodeExecutor);
myConfig.addJob(nodeTestJob);

// Add steps to job
nodeTestJob
  .addStep(new CircleCI.commands.Checkout())
  .addStep(
    new CircleCI.commands.Run({
      command: 'npm install',
      name: 'NPM Install',
    }),
  )
  .addStep(
    new CircleCI.commands.Run({
      command: 'npm run test',
      name: 'Run tests',
    }),
  );

// Add Jobs to Workflow
myWorkflow.addJob(nodeTestJob);

// The `stringify()` function on `CircleCI.Config` will return the CircleCI YAML equivalent.
const MyYamlConfig = myConfig.stringify();

// Save the config to a file in Node.js or the browser. Note, use in the browser requires user interaction.
myConfig.writeFile('config.yml');

MyYamlConfig 将持有以下字符串(一个有效的 CircleCI 配置).

version: 2.1
setup: false
jobs:
  node-test:
    docker:
      - image: cimg/node:lts
    resource_class: medium
    steps:
      - checkout: {}
      - run:
          command: npm install
          name: NPM Install
      - run:
          command: npm run test
          name: Run tests
workflows:
  myWorkflow:
    jobs:
      - node-test: {}

获取帮助

这个开源项目利用GitHub问题和项目委员会来管理 请求和支持.

如果你找不到答案 在现有的 问题, (中文(简体) ), 您可使用适当的模板打开新一期。 问题是最好的办法 circleCI 团队和开源社区可以跟踪和互动 你的问题.

资源

考虑在开启新问题之前检查下列共同资源.

• CircleCI 配置引用
• 配置 SDK API 文档
• 财务问题

捐款

这个 仓库 欢迎社区捐款! 看我们的 捐款额 指导如何配置您的发展环境和如何提交 质量拉动请求.

相关

• 视觉配置编辑器