⚠ Deprecated - Use https://github.com/hoverkraft-tech/ci-github-nodejs

---

GitHub Action: NodeJS Continuous Integration steps

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

Usage

- uses: /@v0.0.0
  with:
    # Description: Checkout parameters. Must be a json object. See
    # https://github.com/actions/checkout
    #
    # Default: { }
    checkout: ""

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

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

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

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

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

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

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

Steps

• Checkout: if checkout is enabled See: https://github.com/actions/checkout

• Setup Node.js: See: https://github.com/actions/setup-node Use given package manager and version retrieve from .nvmrc.

• Install Dependencies If cache hit is not reached

• CodeQL Analysis: If checks and code-ql are enabled. See https://github.com/github/codeql-action

• Build: if build is enabled.
  Handle gatsby cache if gastby is installed.
  Handle storybook cache if storybook is installed.

• Lint: If checks and lint are enabled.

• Test: If checks and test are enabled. Handle Jest cache.

• Code coverage reporting: See https://github.com/codecov/codecov-action If checks and coverage are enabled.

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]

• Website: https://www.escemi.com
• Sponsor: @neilime
• Github: @escemi-tech
• LinkedIn: @escemi

License

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