@form8ion/github-actions-node-ci

github-actions-node-ci

CI scaffolder for JavaScript projects on GitHub Actions

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Execute
• Contributing
  • Dependencies
  • Verification

Usage

Installation

$ npm install @form8ion/github-actions-node-ci --save-prod

Example

Import

import {scaffold, lift, test} from '@form8ion/github-actions-node-ci';

Execute

(async () => {
  await scaffold({
    projectRoot: process.cwd(),
    vcs: {
      owner: 'repo-owner',
      name: 'repo-name'
    },
    runner: 'hosted-runner-name'    // optional. uses `ubuntu-latest` if not provided
  });

  await test({projectRoot: process.cwd()});

  await lift({
    projectRoot: process.cwd(),
    results: {branchesToVerify: ['foo', 'bar']},
    vcs: {owner: 'repo-owner', name: 'repo-name'},
    runner: 'hosted-runner-name'    // optional. uses `ubuntu-latest` if not provided
  });
})();

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test