github-actions-node-ci

CI scaffolder for JavaScript projects on GitHub Actions

[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
[![Codecov][coverage-badge]][coverage-link]
![SLSA Level 2][slsa-badge]

Table of Contents

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

Usage

[![MIT license][license-badge]][license-link]
[![npm][npm-badge]][npm-link]
[![Try @form8ion/github-actions-node-ci on RunKit][runkit-badge]][runkit-link]
![node][node-badge]

$3

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

$3

#### Import

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

#### Execute

`javascript
(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

[![PRs Welcome][PRs-badge]][PRs-link]
[![Conventional Commits][commit-convention-badge]][commit-convention-link]
[![Commitizen friendly][commitizen-badge]][commitizen-link]
[![semantic-release][semantic-release-badge]][semantic-release-link]
[![Renovate][renovate-badge]][renovate-link]

$3

`sh
$ nvm install
$ npm install
`

$3

`sh
$ npm test
``

[PRs-link]: http://makeapullrequest.com

[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg

[commit-convention-link]: https://conventionalcommits.org

[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg

[commitizen-link]: http://commitizen.github.io/cz-cli/

[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg

[semantic-release-link]: https://github.com/semantic-release/semantic-release

[semantic-release-badge]: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release

[renovate-link]: https://renovatebot.com

[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot

[license-link]: LICENSE

[license-badge]: https://img.shields.io/github/license/form8ion/github-actions-node-ci.svg?logo=opensourceinitiative

[npm-link]: https://www.npmjs.com/package/@form8ion/github-actions-node-ci

[npm-badge]: https://img.shields.io/npm/v/@form8ion/github-actions-node-ci?logo=npm

[runkit-link]: https://npm.runkit.com/@form8ion/github-actions-node-ci

[runkit-badge]: https://badge.runkitcdn.com/@form8ion/github-actions-node-ci.svg

[github-actions-ci-link]: https://github.com/form8ion/github-actions-node-ci/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster

[github-actions-ci-badge]: https://img.shields.io/github/actions/workflow/status/form8ion/github-actions-node-ci/node-ci.yml.svg?branch=master&logo=github

[coverage-link]: https://codecov.io/github/form8ion/github-actions-node-ci

[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/github-actions-node-ci?logo=codecov

[slsa-badge]: https://slsa.dev/images/gh-badge-level2.svg

[node-badge]: https://img.shields.io/node/v/@form8ion/github-actions-node-ci?logo=node.js