sinlov/woodpecker-file-browser-sync

woodpecker-file-browser-sync

镜像概述

woodpecker-file-browser-sync是一个用于woodpecker-ci的文件同步插件，基于https://github.com/filebrowser/filebrowser%E5%AE%9E%E7%8E%B0%E6%9C%AC%E5%9C%B0%E8%B7%AF%E5%BE%84%E4%B8%8E%E8%BF%9C%E7%A8%8B%E8%B7%AF%E5%BE%84%E7%9A%84%E6%96%87%E4%BB%B6%E5%90%8C%E6%AD%A5%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8Ewoodpecker-ci%E7%8E%AF%E5%A2%83%E4%B8%8B%E7%9A%84%E6%9E%84%E5%BB%BA%E4%BA%A7%E7%89%A9%E4%B8%8A%E4%BC%A0%E3%80%81%E4%BE%9D%E8%B5%96%E6%96%87%E4%BB%B6%E4%B8%8B%E8%BD%BD%E7%AD%89%E5%9C%BA%E6%99%AF%E3%80%82

核心功能与特性

• 基于filebrowser的同步：本地路径将同步至远程路径，路径格式为{.sync}/${repo-Hostname}/${repo-Owner}/${repo-Name}/{build-number}
• 多URL支持与自动切换：支持配置多个file-browser-urls，可自动切换快速可用的主机；若多URL均不可用，将使用file-browser-standby-url
• dry-run模式：支持仅打印同步信息而不执行实际同步操作
• 上传/下载模式：支持upload（上传）和download（下载）两种同步模式，每种模式均支持sync-include-globs（包含规则）和sync-exclude-globs（排除规则）

配置参数

主要配置参数

高级配置参数

使用示例

1. 使用docker后端的工作流

yaml
labels:
  backend: docker
steps:
  woodpecker-file-browser-sync:
    image: sinlov/woodpecker-file-browser-sync:latest
    pull: false
    settings:
      # debug: true
      # sync-dry-run: true # dry-run模式，仅打印信息不实际同步
      ## 连接配置
      file-browser-urls:
        - https://filebrowser-inner.example.com
        - https://filebrowser.example.com
        - https://filebrowser-zone.example.com
      file-browser-username:
        from_secret: file_browser_sync_username
      file-browser-user-password:
        from_secret: file_browser_sync_password
      # 备用URL
      file-browser-standby-url: https://filebrowser-standby.example.com
      file-browser-standby-username:
        from_secret: file_browser_sync_standby_username
      file-browser-standby-user-passwords:
        from_secret: file_browser_sync_standby_password
      ## 同步配置
      sync-work-space-path: dist # 工作空间下的同步路径（必填）
      sync-mode: upload # 同步模式：upload（上传）或download（下载）
      sync-include-globs: # 包含规则（不可与排除规则同时使用）
        - "**/**/*.dll"
        - "**/*.md"

2. 使用local后端的工作流（需本地安装）

需先本地安装插件并添加到环境变量PATH，可通过https://github.com/woodpecker-kit/woodpecker-file-browser-sync/releases%E4%B8%8B%E8%BD%BD%EF%BC%8C%E6%88%96%E9%80%9A%E8%BF%87%60go install`安装：

bash
# 安装最新版本
go install -a github.com/woodpecker-kit/woodpecker-file-browser-sync/cmd/woodpecker-file-browser-sync@latest

# 安装指定版本（如v1.0.0）
go install -v github.com/woodpecker-kit/woodpecker-file-browser-sync/cmd/woodpecker-file-browser-sync@v1.0.0

工作流配置：

yaml
labels:
  backend: local
steps:
  woodpecker-file-browser-sync:
    image: woodpecker-file-browser-sync
    settings:
      # debug: true
      # sync-dry-run: true # dry-run模式，仅打印信息不实际同步
      ## 连接配置
      file-browser-urls:
        - https://filebrowser-inner.example.com
        - https://filebrowser.example.com
        - https://filebrowser-zone.example.com
      file-browser-username:
        from_secret: file_browser_sync_username
      file-browser-user-password:
        from_secret: file_browser_sync_password
      # 备用URL
      file-browser-standby-url: https://filebrowser-standby.example.com
      file-browser-standby-username:
        from_secret: file_browser_sync_standby_username
      file-browser-standby-user-passwords:
        from_secret: file_browser_sync_standby_password
      ## 同步配置
      sync-work-space-path: dist # 工作空间下的同步路径（必填）
      sync-mode: upload # 同步模式：upload（上传）或download（下载）
      sync-include-globs: # 包含规则（不可与排除规则同时使用）
        - "**/**/*.dll"
        - "**/*.md"

3. 完整配置示例

yaml
labels:
  backend: docker
steps:
  woodpecker-file-browser-sync:
    image: sinlov/woodpecker-file-browser-sync:latest
    pull: false
    settings:
      debug: true
      sync-dry-run: true # dry-run模式，仅打印信息不实际同步
      file-browser-sync-timeout-second: 120 # 文件同步超时时间，最小值60秒
      ## 连接配置
      file-browser-urls:
        - https://filebrowser-inner.example.com
        - https://filebrowser.example.com
        - https://filebrowser-zone.example.com
      file-browser-username:
        from_secret: file_browser_sync_username
      file-browser-user-password:
        from_secret: file_browser_sync_password
      # 备用URL
      file-browser-standby-url: https://filebrowser-standby.example.com
      file-browser-standby-username:
        from_secret: file_browser_sync_standby_username
      file-browser-standby-user-passwords:
        from_secret: file_browser_sync_standby_password
      ## 同步配置
      sync-work-space-path: dist # 工作空间下的同步路径（必填）
      sync-mode: upload # 同步模式：upload（上传）或download（下载）
      sync-include-globs: # 包含规则（不可与排除规则同时使用）
        - "**/**/*.dll"
        - "**/*.md"
      sync-exclude-globs: # 排除规则（不可与包含规则同时使用）
        - "**/node_modules/**"
        - "**/vendor/**"

注意事项

• file-browser-urls支持配置多个URL，但这些URL需指向同一服务，避免同一构建中文件同步异常。
• file-browser-standby-url及相关参数可通过服务器环境变量WOODPECKER_ENVIRONMENT配置，实现多环境复用。例如：

  ini
  WOODPECKER_ENVIRONMENT="PLUGIN_FILE_BROWSER_STANDBY_URL:https://filebrowser-standby.example.com,PLUGIN_FILE_BROWSER_USERNAME:sync-filebrowser,PLUGIN_FILE_BROWSER_STANDBY_USERNAME:sync-filebrowser"
  

  配置后，工作流中可简化为：

  yaml
  labels:
    backend: docker
  steps:
    woodpecker-file-browser-sync:
      image: sinlov/woodpecker-file-browser-sync:latest
      pull: false
      settings:
        # debug: true
        # sync-dry-run: true # dry-run模式，仅打印信息不实际同步
        ## 连接配置
        file-browser-urls:
          - https://filebrowser-inner.example.com
          - https://filebrowser.example.com
          - https://filebrowser-zone.example.com
        file-browser-user-password:
          from_secret: file_browser_sync_password
        # 备用URL
        file-browser-standby-user-passwords:
          from_secret: file_browser_sync_standby_password
        ## 同步配置
        sync-work-space-path: dist # 工作空间下的同步路径（必填）
        sync-mode: upload # 同步模式：upload（上传）或download（下载）
        sync-include-globs: # 包含规则（不可与排除规则同时使用）
          - "**/**/*.dll"
          - "**/*.md"
  

已知限制

• file-browser-standby-url为必填参数，当file-browser-urls均不可用时将使用备用URL；若备用URL也不可用，则不会重试。