a Concourse resource for caching dependencies downloaded by NPM
44b9bf4f
224.1 MB
11 months ago
239.6M
Name
Layer
Last update
about 1 year ago
about 1 year ago
about 1 year ago
about 1 year ago
about 1 year ago
about 1 year ago
11 months ago
about 1 year ago
about 1 year ago
Readme

npm-cache-resource

a Concourse resource for caching dependencies downloaded by NPM - built on mhart/alpine-node and git-resource.

EXAMPLE PIPELINE

Versions

TagFromBowerYarnMaintained
latestmhart/alpine-node:latestYesYesYes
15mhart/alpine-node:15YesYesYes
14mhart/alpine-node:14YesYesYes
12mhart/alpine-node:12YesYesYes
10mhart/alpine-node:10YesYesYes
9mhart/alpine-node:9NoYesNo
8mhart/alpine-node:8NoYesNo
7mhart/alpine-node:7NoNoNo
6mhart/alpine-node:6NoNoNo
4mhart/alpine-node:4NoNoNo
0.12mhart/alpine-node:0.12NoNoNo
0.10mhart/alpine-node:0.10NoNoNo

Resource Configuration

resource_types:

  - name: npm-cache
    type: docker-image
    source: {repository: ymedlop/npm-cache-resource, tag: "12"}

Source Configuration

  • <<:: Required. The source is the same as the corresponding git resource

Configuration to access a Git Private Repo

SSH:

  • private_key: Required. Private key.

HTTP(S):

  • username_key: Required. Username for HTTP(S) auth. This is needed when only HTTP/HTTPS protocol for git is available (which does not support private key auth) and auth is required.
  • password_key: Required. Password for HTTP(S) auth.
  • skip_ssl_verification: Optional. Skips git ssl verification by exporting GIT_SSL_NO_VERIFY=true.

Configuration to access a NPM Registry or Private Registry by User and Password.

  • registry-url: Optional. Private NPM registry to log in to (Default: https://registry.npmjs.org)
  • registry-user: Required. Registry Username.
  • registry-pass: Required. Registry User Password.
  • registry-email: Required. Registry User Email.
  • registry-scope: Optional. Registry Scope.

Configuration to access a Private Registry by Base64 Token

  • registry: Required. The location our private npm registry.
  • token: Required. Our npm token.

Node.js Environment variables

  • node-env: Set NODE_ENV. (Default: development)

Configuration for projects living in subdirectories

  • project-path: Optional Relative path of subdirectory containing the project (i.e. where the package.json is).

Configuration use for npm

  • npm-args: Optional Allow to add extra args to npm i / npm ci command. (Default: "-q")

Configuration use npm ci command

  • npm-ci-support: Optional Allow to use npm ci instead of npm install to install the npm modules into our resource. (Default: false)

Configuration use yarn cli

  • yarn-support: Optional Allow to use yarn to install the npm modules into our resource. (Default: false)
  • yarn-args: Optional Allow to add extra args to yarn install command. (Default: "")

Configuration use bower cli

  • bower-support: Optional Allow to use bower to install packages into our resource (Bower dependency has to be in our package.json). (Default: false)
  • bower-args: Optional Allow to add extra args to bower install command. (Default: "-q --allow-root")
Whatever tool you use to generate the encoded username and password string, try to encode the string admin:admin123, which should result in YWRtaW46YWRtaW4xMjM=. `
Another example for a valid setup is jane:testpassword123 resulting in amFuZTp0ZXN0cGFzc3dvcmQxMjM=.

In our demo we are using admin:123456 resulting in YWRtaW46MTIzNDU2

Example

resources:

  # a perfectly normal source repository with lashings and lashings of dependencies
  - name: repo
    type: git
    source: &repo-source # apply a YAML anchor so we can refer to this in the cache resource
      uri: https://github.com/ymedlop/npm-cache-resource.git
      branch: npm-package-example

  # a resource caching the dependencies listed in the source repository
  - name: npm-repo-cache
    type: npm-cache # as defined above
    source:
      <<: *repo-source # the source is the same as the corresponding git resource ...
      paths: # ... except that it's only interested in files listing dependencies
        - package.json

Behavior

check: Check for new commits

The repository is cloned (or pulled if already present), and any commits from the given version on are returned. If no version is given, the ref for HEAD is returned.

Any commits that contain the string [ci skip] will be ignored. This allows you to commit to your repository without triggering a new version.

in: Pulls a package from npm

Clones the repository to the destination, and locks it down to a given ref. It will return the same given ref as version. And fetch npm package from the package.json`.

Examples

jobs:

  - name: cache
    plan:

      - get: repo
        trigger: true

      - get: npm-repo-cache

  - name: test
    plan:

      - get: repo
        trigger: true
        passed: [cache]

      - get: npm-repo-cache
        passed: [cache]

      - task: run tests
        config:

          platform: linux
          image_resource:
            type: docker-image
            source: {repository: mhart/alpine-node, tag: "12"}

          inputs:
            - name: repo
              path: /src
            - name: npm-repo-cache
              path: /cache

          run:
            path: sh
            args:
              - -exc
              - |
                mv cache/node_modules src
                cd src && npm test

  - name: build
    plan:

      - get: repo
        trigger: true
        passed: [cache]

      - get: npm-repo-cache
        passed: [cache]

      - task: run build
        config:

          platform: linux
          image_resource:
            type: docker-image
            source: {repository: mhart/alpine-node, tag: "12"}

          inputs:
            - name: repo
              path: /src
            - name: npm-repo-cache
              path: /cache

          run:
            path: sh
            args:
              - -exc
              - |
                mv cache/node_modules src
                cd src && npm run build

out: Nothing to do here....

Getting Started

You can see more examples here.

Credits:

License

See the LICENSE file for license text and copyright information.