https://github.com/danielbayley/npm-package-ci

Simple CI GitHub @Actions for your @npm packages.
https://github.com/danielbayley/npm-package-ci

actions automation ci continuous-delivery continuous-integration npm npm-package release testing

Last synced: 6 days ago
JSON representation

Simple CI GitHub @Actions for your @npm packages.

• Host: GitHub
• URL: https://github.com/danielbayley/npm-package-ci
• Owner: danielbayley
• License: mit
• Created: 2024-04-19T17:13:29.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T03:14:47.000Z (4 months ago)
• Last Synced: 2024-08-30T02:54:13.819Z (4 months ago)
• Topics: actions, automation, ci, continuous-delivery, continuous-integration, npm, npm-package, release, testing
• Language: JavaScript
• Homepage: https://github.com/marketplace/actions/npm-package-ci
• Size: 68.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


[`npm`] Package [CI]

====================

Simple CI GitHub [Action] for your [[`p`]]`npm` [package]s.

Usage

-----

Basic `.github/workflows/ci.yml` [reusable workflow] to run [`scripts`].[`test`]s:

~~~ yaml

name: CI

on:

  workflow_dispatch:

  push:

    branches: [main]

jobs:

  CI:

    uses: danielbayley/npm-package-ci/.github/workflows/ci.yml@v1

    #with:

      #node-version: 21, 22

~~~

> [!NOTE]

> Optionally specify `with.node-version`, or version*s* in [CSV] format.

> [Node] versions `20`–`latest` will be tested by default.

> [!WARNING]

> [`corepack`] requires a [lockfile] to operate.

License

-------

[MIT] © [Daniel Bayley]

[MIT]:                LICENSE.md

[Daniel Bayley]:      https://github.com/danielbayley

[node]:               https://nodejs.org/en/about/previous-releases#looking-for-latest-release-of-a-version-branch

[`corepack`]:         https://nodejs.org/api/corepack.html

[lockfile]:           https://pnpm.io/git#lockfiles

[`p`]:                https://pnpm.io

[`npm`]:              https://npmjs.com

[package]:            https://docs.npmjs.com/about-packages-and-modules

[`scripts`]:          https://docs.npmjs.com/cli/using-npm/scripts

[`test`]:             https://docs.npmjs.com/cli/using-npm/scripts#npm-test

[`publish`]:          https://docs.npmjs.com/cli/commands/npm-publish

[ci]:                 https://docs.github.com/actions/automating-builds-and-tests/about-continuous-integration

[action]:             https://github.com/features/actions

[reusable workflow]:  https://docs.github.com/actions/using-workflows/reusing-workflows

[csv]:                https://wikipedia.org/wiki/Comma-separated_values