bobvanlooveren/npm-cache-resource

npm-cache-resource镜像说明

镜像概述

本镜像为Concourse CI的资源类型，用于缓存NPM下载的依赖包，基于标准Node.js（stretch版本）构建，替代alpine版本以适配特定环境需求。支持多种Node.js版本及依赖管理工具（npm、yarn、bower），有效减少CI/CD流程中重复下载依赖的时间成本。

核心功能

1. 依赖缓存：缓存package.json定义的NPM依赖，避免重复下载。
2. 多版本支持：提供Node.js 0.10、0.12、4、6、7、8、9、10及latest版本的镜像。
3. Git兼容：支持Git私有仓库的SSH/HTTP(S)认证方式。
4. 私有Registry支持：通过用户名密码或Base64 Token访问私有NPM仓库。
5. 工具扩展：支持npm ci、yarn、bower等依赖管理工具。

使用场景

适用于Concourse CI/CD流水线中频繁安装NPM依赖的场景（如代码构建、测试环节），通过缓存依赖包显著缩短任务执行时间。

配置说明

资源类型定义

yaml
resource_types:
  - name: npm-cache
    type: docker-image
    source: {repository: bobvanlooveren/npm-cache-resource, tag: "10"} # 替换为所需Node版本

源配置

Git私有仓库

• SSH方式：需提供private_key（私钥）。
• HTTP(S)方式：需提供username_key（用户名）、password_key（密码），可选skip_ssl_verification（跳过SSL验证）。

NPM私有Registry

• 用户名密码：registry-url（仓库地址）、registry-user（用户名）、registry-pass（密码）、registry-email（***），可选registry-scope（作用域）。
• Base64 Token：registry（仓库地址）、token（Base64编码令牌）。

其他配置

• Node环境：node-env（设置NODE_ENV，默认development）。
• 子目录项目：project-path（package.json所在子目录路径）。
• 工具开关：npm-ci-support（启用npm ci）、yarn-support（启用yarn）、bower-support（启用bower），默认均为false。

部署示例

资源配置

yaml
resources:
  - name: repo
    type: git
    source: &repo-source
      uri: https://github.com/your-repo.git
      branch: main
  - name: npm-repo-cache
    type: npm-cache
    source:
      <<: *repo-source
      paths: [package.json] # 仅监控依赖配置文件

任务使用

yaml
jobs:
  - name: run-tests
    plan:
      - get: repo
        trigger: true
      - get: npm-repo-cache
      - task: test
        config:
          platform: linux
          image_resource:
            type: docker-image
            source: {repository: mhart/alpine-node, tag: "10"}
          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

行为说明

• check：检查Git仓库新提交，忽略含[ci skip]的提交。
• in：拉取代码并缓存依赖包。
• out：无操作。

许可证

遵循原项目许可证协议，详情见原仓库LICENSE文件。