sinlov/woodpecker-npm

woodpecker-npm

概述和主要用途

woodpecker-npm是一个用于Woodpecker CI的NPM包发布工具，旨在简化NPM包的自动化发布流程。它支持通过用户名密码或令牌进行认证，可自定义NPM仓库、发布目录、标签、访问权限等参数，并提供版本冲突处理、调试日志等功能，适用于各类NPM包的持续集成发布场景。

使用前准备

• 请先查看npm官方文档中package.json的定义
• 准备用于发布NPM包的username和password，或token
• 将.npmrc添加到.gitignore中
• 确保在npm-folder或工作区路径下存在package.json，并通过npm文档中的publishconfig配置registry，示例如下：

json
{
  "publishConfig": {
    "registry": "https://registry.npmjs.org/"
  }
}

配置参数

主要设置

自定义设置

隐藏设置

使用示例

Docker后端工作流

yml
labels:
  backend: docker
steps:
  woodpecker-npm:
    image: sinlov/woodpecker-npm:latest
    pull: false
    settings:
      # debug: true  # 开启调试日志
      ## 仓库设置，为空则使用https://registry.npmjs.org/
      # npm-registry: https://verdaccio.foo.com
      npm-username:  # NPM用户名
        from_secret: npm_publish_username
      npm-password:  # NPM密码
        from_secret: npm_publish_password
      npm-email:  # NPM邮箱
        from_secret: npm_publish_email
      # npm-dry-run: true  # dry run模式，不会发布到NPM仓库
      # npm-folder: .  # 包含package.json的目录，为空则使用工作区
      # npm-tag: alpha  # 避免标记为latest的发布标签，常用beta、alpha、experimental等，不要使用latest、next
      ## 若版本已存在于NPM仓库则发布失败，多用于标签发布
      # npm-fail-on-version-conflict: true

Local后端工作流

需在本地安装并确保在环境变量PATH中生效。

本地安装

• 安装最新版到${GOPATH}/bin：

  bash
  go install -a github.com/woodpecker-kit/woodpecker-npm/cmd/woodpecker-npm@latest
  

• 安装v1.0.0版本到${GOPATH}/bin：

  bash
  go install -v github.com/woodpecker-kit/woodpecker-npm/cmd/woodpecker-npm@v1.0.0
  

工作流配置

yml
labels:
  backend: local
steps:
  woodpecker-npm:
    image: woodpecker-npm
    settings:
      # debug: true  # 开启调试日志
      ## 仓库设置，为空则使用https://registry.npmjs.org/
      # npm-registry: https://verdaccio.foo.com
      npm-username:  # NPM用户名
        from_secret: npm_publish_username
      npm-password:  # NPM密码
        from_secret: npm_publish_password
      npm-email:  # NPM邮箱
        from_secret: npm_publish_email
      # npm-dry-run: true  # dry run模式，不会发布到NPM仓库
      # npm-folder: .  # 包含package.json的目录，为空则使用工作区
      # npm-tag: alpha  # 避免标记为latest的发布标签，常用beta、alpha、next等
      ## 若版本已存在于NPM仓库则发布失败，多用于标签发布
      # npm-fail-on-version-conflict: true

settings.debug说明

若开启settings.debug，将尝试使用override进行文件浏览以调试。

完整配置示例

yaml
labels:
  backend: docker
steps:
  woodpecker-npm:
    image: sinlov/woodpecker-npm:latest
    pull: false
    settings:
      # debug: true  # 开启调试日志
      ## 仓库设置，为空则使用https://registry.npmjs.org/
      # npm-registry: https://verdaccio.foo.com
      ## NPM用户名
      npm-username:
        from_secret: npm_publish_username
      ## NPM密码
      npm-password:
        from_secret: npm_publish_password
      ## 发布包时使用的NPM令牌。如果设置了令牌，用户名和密码将被忽略。
      npm-token:
        from_secret: npm_publish_token
      ## NPM邮箱
      npm-email:
        from_secret: npm_publish_email
      npm-dry-run: true  # dry run模式，不会发布到NPM仓库
      ## 发布包时使用的NPM标签，将覆盖package.json的version字段
      npm-tag: alpha  # 避免标记为latest的发布标签，常用beta、alpha、next等
      npm-force-tag: true  # 当标签不是`latest`或`next`时，通过semver检查预发布版本前缀并强制发布
      ## NPM作用域包的访问权限
      npm-access: foo
      ## 包含package.json的目录，为空则使用工作区
      npm-folder: .
      ## 若版本已存在于NPM仓库则发布失败
      npm-fail-on-version-conflict: true
      ## 禁用与NPM仓库通信时的SSL验证
      npm-skip-verify-ssl: true
      ## 跳过npm whoami检查
      npm-skip-whoami: true
      ## 启用在用户主目录写入.npmrc文件，默认在`npm-folder`中写入
      npm-rc-user-home-enable: true