calibreapp/github-image-actions

Calibre Image Actions Docker镜像说明

概述

Image Actions是由Calibre性能专家开发的GitHub Action，该Docker镜像封装了此Action，可自动压缩Pull Request中的JPEG、PNG和WebP图片。它提供以下核心特性：

• 快速高效的近无损压缩
• 使用行业最优算法（mozjpeg和libvips）
• 灵活的自定义配置（质量调整、路径忽略等）
• 支持按需触发或定时运行

使用方法

1. 在仓库中创建.github/workflows/calibreapp-image-actions.yml文件，内容如下：

yml
name: Compress Images
on:
  pull_request:
    paths:
      - '**.jpg'
      - '**.jpeg'
      - '**.png'
      - '**.webp'
jobs:
  build:
    if: github.event.pull_request.head.repo.full_name == github.repository
    name: calibreapp/image-actions
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@master
      - name: Compress Images
        uses: calibreapp/image-actions@master
        with:
          githubToken: ${{ secrets.GITHUB_TOKEN }}

2. 提交包含新增/修改图片的Pull Request，Image Actions会自动处理并发布压缩结果评论。
3. 合并Pull Request即可应用优化后的图片，或参考配置说明扩展功能。

配置说明

控制图片质量

通过以下参数调整压缩质量：

yml
with:
  jpegQuality: '80'  # JPEG质量（1-100，默认80）
  jpegProgressive: false  # 是否启用渐进式JPEG
  pngQuality: '80'  # PNG质量（1-100，默认80）
  webpQuality: '80'  # WebP质量（1-100，默认80）

忽略指定路径

使用逗号分隔的通配符字符串忽略特定路径：

yml
with:
  ignorePaths: 'node_modules/**,build'

仅压缩模式

跳过提交和评论，仅生成压缩结果：

yml
with:
  compressOnly: true

按需/定时压缩

结合workflow_dispatch（手动触发）或schedule（定时任务）实现灵活压缩：

yml
name: Compress Images
on:
  workflow_dispatch:
  schedule:
    - cron: '00 23 * * 0'  # 每周日23:00运行
jobs:
  build:
    name: calibreapp/image-actions
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repo
        uses: actions/checkout@master
      - name: Compress Images
        id: calibre
        uses: calibreapp/image-actions@master
        with:
          githubToken: ${{ secrets.GITHUB_TOKEN }}
          compressOnly: true
      - name: Create PR If Needed
        if: steps.calibre.outputs.markdown != ''
        uses: peter-evans/create-pull-request@master
        with:
          title: 夜间图片压缩
          branch-suffix: timestamp
          commit-message: 压缩图片
          body: ${{ steps.calibre.outputs.markdown }}

处理分叉仓库PR

默认不支持分叉仓库PR，可通过以下方式解决：

1. 使用具有分叉访问权限的PAT替换GITHUB_TOKEN（需注意安全）
2. 仅对本仓库PR运行（推荐）：

yml
if: github.event.pull_request.head.repo.full_name == github.repository

迁移旧配置

若使用旧版本，需更新：

1. uses与Token配置：将docker://格式改为calibreapp/image-actions@master，并使用with传递githubToken
2. 配置文件位置：从.github/calibre/image-actions.yml迁移到.github/workflows/目录
3. ignorePaths格式：从数组改为逗号分隔字符串

贡献指南

1. Fork仓库并安装依赖：npm install
2. 构建项目：npm run build或npm run watch（实时编译）
3. 修改代码并运行测试：npm run test
4. 验证Docker构建：docker build -t calibreapp/image-actions:dev .
5. 提交Pull Request

许可证

本镜像基于GNU General Public License授权。