Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
box

GitHub Action

NodeJS Continuous Integration steps

v1.9.0

NodeJS Continuous Integration steps

box

NodeJS Continuous Integration steps

Composite Github Action to provides opinionated NodeJS steps to performs Continuous Integration

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: NodeJS Continuous Integration steps

              
  uses: escemi-tech/[email protected]
Learn more about this action in escemi-tech/actions-node

Choose a version

GitHub Action:Node steps

Composite Github Action to provides opinionated NodeJS steps

Usage

- uses: escemi-tech/actions-node@main
  with:
    # Checkout parameters. Must be a json object. See https://github.com/actions/checkout
    # Default: { }
    checkout: ""

    # Used to specify a package manager. Supported values: 'yarn'
    # Default: yarn
    package-manager: ""

    # Build parameters. Must be a string or a json object.
    # Default: build
    build: ""

    # Optional flag to enable check steps.
    checks: ""

    # Optional flag to enable linting
    # Default: true
    lint: ""

    # Code QL analysis language. See https://github.com/github/codeql-action
    # Default: typescript
    code-ql: ""

    # Optional flag to enable test. See https://github.com/github/codeql-action
    # Default: true
    test: ""

    # Optional flag to enable coverage report. See https://github.com/codecov/codecov-action
    # Default: true
    coverage: ""

Steps

Inputs

See action.yml

Input Description Default Required
checkout Checkout parameters. Must be a json object. See https://github.com/actions/checkout { } false
package-manager Used to specify a package manager. Supported values: 'yarn' yarn false
build Build parameters. Must be a string or a json object. build false
checks Optional flag to enable check steps. false
lint Optional flag to enable linting true false
code-ql Code QL analysis language. See https://github.com/github/codeql-action typescript false
test Optional flag to enable test. See https://github.com/github/codeql-action true false
coverage Optional flag to enable coverage report. See https://github.com/codecov/codecov-action true false

Examples

checkout:

It can be a json object to specify the token to be used. Example:

steps:
  - uses: escemi-tech/actions-node@main
    with:
      checkout: '{ "token": "${{ secrets.GH_PRIVATE_ACCESS_TOKEN }}" }'

It can be a false to disabliing checkout. Example:

steps:
  - uses: escemi-tech/actions-node@main
    with:
      checkout: false

build:

It can be a string to specify the script to run. Example:

steps:
  - uses: escemi-tech/actions-node@main
    with:
      build: "build:prod"

It can be a json object to specify the script and / or the env variables. Example:

steps:
  - uses: escemi-tech/actions-node@main
    with:
      build: '{ "env": { "NODE_ENV": "production" } }'

Helping Project

❤️ If this project helps you reduce time to develop and/or you want to help the maintainer of this project. You can sponsor him. Thank you !

Contributing

👍 If you wish to contribute to actions-node, please read the CONTRIBUTING.md file, PRs are Welcome !

Author

🏢 ESCEMI [email protected]

License

📝 Copyright © 2021 ESCEMI [email protected].
This project is MIT licensed.