Pipery npm CI#

Repository: pipery-npm-ci
Release tag: v1.1.0
Catalog: /catalog/

Reusable GitHub Action for a complete npm/Node.js CI pipeline with structured logging via Pipery.

Table of Contents#

Quick Start
Pipeline Overview
Configuration Options
Usage Examples
GitLab CI
Bitbucket Pipelines
About Pipery
Development

Quick Start#

name: CI
on: [push, pull_request]

jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: pipery-dev/npm-ci@v1.1.0
        with:
          project_path: .
          npm_token: ${{ secrets.NPM_TOKEN }}
          github_token: ${{ secrets.GITHUB_TOKEN }}

Pipeline Overview#

Step	Tool	Skip Input	Description
SAST	njsscan	`skip_sast`	Detects common Node.js security issues
SCA	npm audit / yarn audit	`skip_sca`	Identifies vulnerable dependencies
Lint	ESLint	`skip_lint`	Enforces code style and quality
Build	`npm run build` / `yarn build`	`skip_build`	Compiles or bundles your application
Test	`npm test` / `yarn test`	`skip_test`	Runs unit and integration tests
Version	Semantic versioning	`skip_versioning`	Bumps version and creates git tag
Package	`npm pack`	`skip_packaging`	Creates distributable package
Release	npm publish	`skip_release`	Publishes to npm registry
Reintegrate	Git merge	`skip_reintegration`	Merges back to default branch

Configuration Options#

Name	Default	Description
`project_path`	`.`	Path to the project source tree.
`config_file`	`.pipery/config.yaml`	Path to Pipery config file.
`node_version`	`20`	Node.js version to use (e.g., `18`, `20`, `22`).
`package_manager`	`auto`	Package manager: `auto`, `npm`, or `yarn`.
`tests_path`	``	Path or glob passed to the test runner after `--`.
`version_bump`	`patch`	Version bump type: `patch`, `minor`, or `major`.
`npm_token`	``	npm registry auth token for publishing.
`github_token`	``	GitHub token for reintegration.
`log_file`	`pipery.jsonl`	Path to the JSONL structured log file.
`registry`	`npmjs`	Registry target for release.
`skip_sast`	`false`	Skip the SAST step.
`skip_sca`	`false`	Skip the SCA step.
`skip_lint`	`false`	Skip the lint step.
`skip_build`	`false`	Skip the build step.
`skip_test`	`false`	Skip the test step.
`skip_versioning`	`false`	Skip the versioning step.
`skip_packaging`	`false`	Skip the packaging step.
`skip_release`	`false`	Skip the release step.
`skip_reintegration`	`false`	Skip the reintegration step.

Usage Examples#

Example 1: Basic npm project with all steps#

name: CI
on: [push, pull_request]

jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: pipery-dev/npm-ci@v1.1.0
        with:
          project_path: .
          node_version: "20"
          npm_token: ${{ secrets.NPM_TOKEN }}
          github_token: ${{ secrets.GITHUB_TOKEN }}

Example 2: Yarn-based project#

- uses: pipery-dev/npm-ci@v1.1.0
  with:
    project_path: .
    package_manager: yarn
    npm_token: ${{ secrets.NPM_TOKEN }}
    github_token: ${{ secrets.GITHUB_TOKEN }}

Example 3: Skip packaging and release (CI only)#

- uses: pipery-dev/npm-ci@v1.1.0
  with:
    project_path: .
    skip_packaging: true
    skip_release: true

Example 4: Custom test path#

- uses: pipery-dev/npm-ci@v1.1.0
  with:
    project_path: .
    tests_path: "src/**/*.test.ts"
    npm_token: ${{ secrets.NPM_TOKEN }}
    github_token: ${{ secrets.GITHUB_TOKEN }}

Example 5: Minor version bump for release#

- uses: pipery-dev/npm-ci@v1.1.0
  with:
    project_path: .
    version_bump: minor
    npm_token: ${{ secrets.NPM_TOKEN }}
    github_token: ${{ secrets.GITHUB_TOKEN }}

Example 6: Private registry deployment#

- uses: pipery-dev/npm-ci@v1.1.0
  with:
    project_path: .
    registry: npm.example.com
    npm_token: ${{ secrets.PRIVATE_NPM_TOKEN }}
    github_token: ${{ secrets.GITHUB_TOKEN }}

GitLab CI#

Use the GitLab mirror template when .gitlab-ci.yml is published for this pipeline family. Import it from the mirrored GitLab project or use it as a reference implementation for running the same Pipery pipeline outside GitHub Actions.

The GitLab pipeline maps action inputs to CI/CD variables, publishes pipery.jsonl as an artifact, and maintains the same skip controls. Store credentials as protected GitLab CI/CD variables.

include:
  - project: pipery-dev/npm-ci
    ref: v1.1.0
    file: /.gitlab-ci.yml

GitLab CI Variables#

Configure these protected variables in Settings > CI/CD > Variables:

NPM_TOKEN - npm registry authentication token
GITHUB_TOKEN - GitHub API access for reintegration
NODE_VERSION - Node.js version (default: 20)
PACKAGE_MANAGER - auto/npm/yarn (default: auto)
VERSION_BUMP - patch/minor/major (default: patch)

Bitbucket Pipelines#

Bitbucket Cloud pipelines provide an alternative to GitHub Actions. Use Bitbucket shared pipeline imports to reference the exported Pipery pipeline instead of copying YAML into every application repository.

Quick Start#

Add a Bitbucket import source for the shared Pipery pipeline and import the exported pipeline by name:

definitions:
  imports:
    pipery-shared: pipery-dev/npm-ci:v1.1.0
    pipery-custom: pipery-dev/npm-ci:v1.1.0:.bitbucket/shared-pipelines.yml

pipelines:
  branches:
    main:
      import: pipery-npm-ci@pipery-shared

  custom:
    run-pipery:
      import: pipery-npm-ci@pipery-custom

Use {project-path}/{repo-slug}:{branch-or-tag} for a shared repository bitbucket-pipelines.yml, or {project-path}/{repo-slug}:{branch-or-tag}:{config-filepath} for another exported YAML file.

Configure Protected Variables in Repository Settings > Pipelines > Repository Variables:
- NPM_TOKEN - npm registry authentication token
- GITHUB_TOKEN - GitHub API access (for reintegration)
- NODE_VERSION - Node.js version (default: 20)
Commit and push to trigger the pipeline

Pipeline Stages#

The Bitbucket equivalent follows the same structure:

checkout → setup → SAST (njsscan) → SCA (npm audit) → lint (ESLint) → build → test → versioning → packaging → release → reintegration → logs

Skip Flags#

Disable any stage using environment variables:

SKIP_SAST, SKIP_SCA, SKIP_LINT, SKIP_BUILD, SKIP_TEST, SKIP_VERSIONING, SKIP_PACKAGING, SKIP_RELEASE, SKIP_REINTEGRATION

Example: Set SKIP_SAST=true to skip security scanning.

Features#

Same security scanning tools (njsscan, npm audit, ESLint)
Parallel SAST and SCA stages
Auto-detects npm or yarn
Automatic versioning and tagging
npm publish with token authentication
JSONL-based pipeline logging
30-90 day artifact retention

About Pipery#

Pipery Pipery is an open-source CI/CD observability platform. Every step script runs under psh (Pipery Shell), which intercepts all commands and emits structured JSONL events — giving you full visibility into your pipeline without any manual instrumentation.

Browse logs in the Pipery Dashboard
Find all Pipery actions on GitHub Marketplace
Source code: pipery-dev

Development#

# Run the action locally against test-project/
pipery-actions test --repo .

# Regenerate docs
pipery-actions docs --repo .

# Dry-run release
pipery-actions release --repo . --dry-run