mrauhu/deversion

Github Action that removes the version from a package-lock.json.

Superpowers the node_modules cache step. Lets you skip the installation step even if the version of your Node.js package was bumped via npm version command.

Usage

Add the mrauhu/deversion action before actions/cache, configure the cache action and check the cache hit after:

- uses: mrauhu/deversion@v1
- uses: actions/cache@v2
  id: cache
  with:
    path: node_modules
    key: ${{ runner.os }}-node_modules-${{ hashFiles('package-lock.json') }}
- if: steps.cache.outputs.cache-hit != 'true'
  run: npm ci

Example

.github/workflows/npm-publish.yml

name: Node.js package
on:
  push:
    branches:
      # Your default branch cache is available to other branches and tags
      - master
    tags:
      - "v*"

jobs:
  test-and-publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v2
        with:
          node-version: 12
          registry-url: https://npm.pkg.github.com/
      # Removes the `version` key from a `package-lock.json`
      - uses: mrauhu/deversion@v1
      # Now you have same key if the dependencies is haven't changed
      - uses: actions/cache@v2
        id: cache
        with:
          path: node_modules
          key: ${{ runner.os }}-node_modules-${{ hashFiles('package-lock.json') }}
      # Install if dependencies is changed or cache expired
      - if: steps.cache.outputs.cache-hit != 'true'
        run: npm ci
      - run: npm test
      # Publish only `v*` tags
      - if: startsWith(github.ref, 'refs/tags/v')
        run: npm publish
        env:
          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}