Manage node packages on your Github Action repository.

• Requirements
• Usage
• Notes

You must include the YAML configuration file in your repository. If you don't specify its path to the config key in your workflow, the action will try to find it in your .github directory and then in root (./) .

Any of the following are accepted config file names.

• npmworker.config.yaml
• npmworker.config.yml
• npm.worker.config.yaml
• npm.worker.config.yml

• Here we specify the workflow should only run when a change to our config file is made.

# ./.github/workflows/npmworker.yaml

name: NPM Worker
on:
  push:
    branches:
      - master:
    paths:
      - ./path/to/npmworker.config.yaml
jobs:
  npm:
    runs-on: ubuntu-latest
    name: NPM Worker
    steps:
      - uses: actions/checkout@v2
      - name: Worker
        uses: mudlabs/[email protected]
        with:
          # OPTIONAL: Provide a PAT for the repository, so the
          # action can log activity to an issue.
          # Default: github.token
          token: ${{ secrets.GITHUB_TOKEN }}
          # OPTIONAL: Provide a path within your repository to
          # the YAML configuration file.
          # If not provided the action will attempt to find it
          # before failing.
          config: ./path/to/npmworker.config.yaml

• If you want to remove a package it's not enough to remove it from the install array, you need to add it to the uninstall array.

# Example Configuration
clean: true
init: true
issue: 1
path: ./dis
install:
  - "@actions/github"
  - unirest
update:
  - cardinal-direction
uninstall:
  - node-fetch

• If you want the node_modules and packages to persist on your repository you will need to commit the changes. I recommend using the Add and Commit action for this.
• You can not chain executions. Each array item is checked for, and broken at any instance of &&.
• Each array item is executed as npm x item (i.e. npm install unirest).