ymedlop/npm-cache-resource

npm-cache-resource

概述

npm-cache-resource是一个Concourse资源，用于缓存NPM下载的依赖项，基于https://hub.docker.com/r/mhart/alpine-node%E5%92%8Chttps://github.com/concourse/git-resource%E6%9E%84%E5%BB%BA%E3%80%82

!https://raw.githubusercontent.com/ymedlop-sandbox/npm-cache-resource/gh-pages/images/example-pipeline.png

版本

资源配置

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

源配置

• <<:: 必填。源配置与对应的git资源相同。

访问Git私有仓库的配置

SSH方式：

• private_key: 必填。私钥。

HTTP(S)方式：

• username_key: 必填。HTTP(S)认证用户名。当仅支持HTTP/HTTPS协议（不支持私钥认证）且需要认证时使用。
• password_key: 必填。HTTP(S)认证密码。
• skip_ssl_verification: 可选。通过设置GIT_SSL_NO_VERIFY=true跳过Git SSL验证。

通过用户名和密码访问NPM仓库或私有仓库的配置

• registry-url: 可选。要登录的私有NPM仓库（默认：[***]
• registry-user: 必填。仓库用户名。
• registry-pass: 必填。仓库用户密码。
• registry-email: 必填。仓库用户***。
• registry-scope: 可选。仓库作用域。

通过Base64令牌访问私有仓库的配置

• registry: 必填。私有npm仓库地址。
• token: 必填。npm令牌。

Node.js环境变量

• node-env: 设置NODE_ENV环境变量（默认：development）。

子目录项目配置

• project-path: 可选。包含项目的子目录相对路径（即package.json所在位置）。

npm配置

• npm-args: 可选。允许为npm i/npm ci命令添加额外参数（默认："-q"）。

npm ci命令配置

• npm-ci-support: 可选。允许使用npm ci代替npm install安装依赖（默认：false）。

Yarn配置

• yarn-support: 可选。允许使用Yarn安装依赖（默认：false）。
• yarn-args: 可选。允许为yarn install命令添加额外参数（默认：""）。

Bower配置

• bower-support: 可选。允许使用Bower安装包（Bower依赖必须在package.json中）（默认：false）。
• bower-args: 可选。允许为bower install命令添加额外参数（默认："-q --allow-root"）。

用于生成编码的用户名和密码字符串的工具，尝试编码字符串admin:admin123，结果应为YWRtaW46YWRtaW4xMjM=。另一个有效示例：jane:testpassword123编码后为amFuZTp0ZXN0cGFzc3dvcmQxMjM=。演示中使用admin:123456编码后为YWRtaW46MTIzNDU2。

示例

yaml
resources:
  # 一个包含大量依赖的普通源代码仓库
  - name: repo
    type: git
    source: &repo-source # 使用YAML锚点，以便在缓存资源中引用
      uri: https://github.com/ymedlop/npm-cache-resource.git
      branch: npm-package-example

  # 缓存源代码仓库中依赖列表的资源
  - name: npm-repo-cache
    type: npm-cache # 如上文定义
    source:
      <<: *repo-source # 源配置与对应的git资源相同...
      paths: # ...但仅关注列出依赖的文件
        - package.json

行为

check: 检查新提交

克隆仓库（如果已存在则拉取），返回指定版本之后的所有提交。如果未指定版本，则返回HEAD的引用。

包含字符串[ci skip]的提交将被忽略，允许提交代码而不触发新版本。

in: 从npm拉取包

将仓库克隆到目标位置，并锁定到指定的引用。返回与给定引用相同的版本，并从package.json中获取npm包。

示例

yaml
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: 无操作

入门

更多示例可查看https://github.com/ymedlop-sandbox/npm-cache-resource/tree/examples%E3%80%82

致谢

• https://github.com/concourse/git-resource
• 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%E6%AD%A4%E9%A1%B9%E7%9B%AE%E5%88%9B%E5%BB%BA

许可证

详见LICENSE文件中的许可文本和版权信息。