工作流程- 核心

管理 github 工作流程的 form8ion 插件的核心功能

目录

• 使用量
  • 安装
  • 示例
    • 导入
    • 执行
  • API 密码
    • scaffoldCheckoutStep
    • scaffoldNodeSetupStep
      • versionDeterminedBy 字符串 (单位:千美元)所需经费(中文(简体) )
    • scaffoldDependencyInstallationStep
    • scaffoldVerificationStep
• 捐款
  • 依赖关系
  • 核查

使用量

安装

$ npm install @form8ion/github-workflows-core --save-prod

示例

导入

import {
  scaffoldCheckoutStep,
  scaffoldNodeSetupStep,
  scaffoldDependencyInstallationStep,
  scaffoldVerificationStep,
  loadWorkflowFile,
  writeWorkflowFile,
  workflowFileExists,
  renameWorkflowFile
} from '@form8ion/github-workflows-core';

执行

const projectRoot = process.cwd();

(async () => {
  scaffoldCheckoutStep();

  scaffoldNodeSetupStep({versionDeterminedBy: 'nvmrc'});

  scaffoldDependencyInstallationStep();

  scaffoldVerificationStep();

  if (await workflowFileExists({projectRoot, name: 'existing-workflow-name'})) {
    await loadWorkflowFile({projectRoot, name: 'existing-workflow-name'});
  }

  await writeWorkflowFile({projectRoot, name: 'workflow-name', config: {}});

  await renameWorkflowFile({projectRoot, oldName: 'existing-workflow-name', newName: 'new-workflow-name'});
})();

API 密码

scaffoldCheckoutStep

脚手架,以定义一个步骤的细节,以便在 GitHub 工作流程

scaffoldNodeSetupStep

脚手架,用于定义一个步骤的细节,以便在 a GitHub 工作流程

以单个选项对象作为参数,包含:

versionDeterminedBy 字符串 (单位:千美元)所需经费(中文(简体) )

用于已配置步骤的节点版本的来源 。 有效的选项是 nvmrc 或者说 matrix

scaffoldDependencyInstallationStep

脚手架,用于定义在 GitHub 中安装依赖性步骤的细节 工作流程

scaffoldVerificationStep

脚手架以定义执行核查步骤的细节

捐款

依赖关系

$ nvm install
$ npm install

核查

$ npm test