arwineap/npm-cache-resource

npm-cache-resource镜像

镜像概述

这是Concourse CI/CD平台的资源镜像，用于缓存NPM依赖包以加速Node.js项目构建流程，在原npm-cache-resource基础上添加了autoconf支持，增强兼容性。

核心功能

1. 缓存NPM依赖包，减少重复下载耗时
2. 兼容Concourse流水线配置，无缝集成CI/CD流程
3. 支持私有NPM registry认证（用户名密码或Base64 Token两种方式）
4. 忽略含[ci skip]字符串的提交，避免不必要的构建触发

使用场景

• Node.js前端项目的自动化构建流水线
• 频繁安装NPM依赖的开发/测试流程
• 私有NPM registry环境下的依赖缓存管理

配置说明

资源类型配置

在Concourse流水线中定义资源类型：

yaml
resource_types:
  - name: npm-cache
    type: docker-image
    source: {repository: arwineap/npm-cache-resource, tag: latest}

源配置

基础配置（继承Git资源）

yaml
resources:
  # 原Git资源
  - name: react-redux-badges-repo
    type: git
    source: &react-redux-badges-repo-source
      uri: https://github.com/ymedlop-sandbox/react-redux-badges.git
  
  # npm缓存资源（继承Git配置）
  - name: npm-repo-cache
    type: npm-cache
    source:
      <<: *react-redux-badges-repo-source
      paths: # 关注的依赖文件
        - package.json

私有Registry（用户名密码方式）

yaml
source:
  registry-url: https://your-private-registry.com # 可选，默认npm官方registry
  registry-user: your-username # 必填
  registry-pass: your-password # 必填
  registry-email: your-email@example.com # 必填
  registry-scope: @your-scope # 可选

私有Registry（Base64 Token方式）

yaml
source:
  registry: https://your-private-registry.com # 必填
  token: YWRtaW46MTIzNDU2 # 必填（示例：admin:123456的Base64编码）

行为说明

check：检查新提交

克隆/拉取仓库，返回指定版本后的新提交；忽略含[ci skip]的提交。

in：拉取NPM包

克隆仓库到目标路径，锁定到指定版本，并从package.json获取依赖包。

out：无操作

使用示例

Concourse流水线缓存+测试任务示例：

yaml
jobs:
  - name: cache
    plan:
      - get: react-redux-badges-repo
        trigger: true
      - get: npm-repo-cache
  
  - name: test
    plan:
      - get: react-redux-badges-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: "6"}
          inputs:
            - name: react-redux-badges-repo
              path: /src
            - name: npm-repo-cache
              path: /cache
          run:
            path: sh
            args:
              - -exc
              - |
                cp -R cache/node_modules src
                cd src && npm test

开始使用

查看示例：

• 简单示例
• 私有Registry示例

Credits

• https://github.com/projectfalcon/gradle-cache-resource%EF%BC%9A%E6%9C%AC%E8%B5%84%E6%BA%90%E5%8F%82%E8%80%83%E8%AF%A5%E9%A1%B9%E7%9B%AE%E5%AE%9E%E7%8E%B0%E3%80%82

License

详见LICENSE文件。