github-workflows-core

core functionality for form8ion plugins that manage github workflows

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Execute
  • API
    • scaffoldCheckoutStep
    • scaffoldNodeSetupStep
      • versionDeterminedBy string (required)
    • scaffoldDependencyInstallationStep
    • scaffoldVerificationStep
• Contributing
  • Dependencies
  • Verification

Usage

Installation

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

Example

Import

1import {
2  scaffoldCheckoutStep,
3  scaffoldNodeSetupStep,
4  scaffoldDependencyInstallationStep,
5  scaffoldVerificationStep,
6  loadWorkflowFile,
7  writeWorkflowFile,
8  workflowFileExists,
9  renameWorkflowFile
10} from '@form8ion/github-workflows-core';

Execute

1const projectRoot = process.cwd();
2
3(async () => {
4  scaffoldCheckoutStep();
5
6  scaffoldNodeSetupStep({versionDeterminedBy: 'nvmrc'});
7
8  scaffoldDependencyInstallationStep();
9
10  scaffoldVerificationStep();
11
12  if (await workflowFileExists({projectRoot, name: 'existing-workflow-name'})) {
13    await loadWorkflowFile({projectRoot, name: 'existing-workflow-name'});
14  }
15
16  await writeWorkflowFile({projectRoot, name: 'workflow-name', config: {}});
17
18  await renameWorkflowFile({projectRoot, oldName: 'existing-workflow-name', newName: 'new-workflow-name'});
19})();

API

scaffoldCheckoutStep

Scaffolder to define the details for a step to check out the project in a GitHub workflow

scaffoldNodeSetupStep

Scaffolder to define the details for a step to set up a node.js environment in a GitHub workflow

Takes a single options object as an argument, containing:

versionDeterminedBy string (required)

Source of node version for use in the configured step. Valid options are nvmrc or matrix

scaffoldDependencyInstallationStep

Scaffolder to define the details for a step to install dependencies in a GitHub workflow

scaffoldVerificationStep

Scaffolder to define the details for a step to execute verification

Contributing

Dependencies

1$ nvm install
2$ npm install

Verification

1$ npm test