namoscato/github-action-tinify

Tinify Image Action

概述

Tinify Image Action 是一个 GitHub Action，通过 Tinify API（TinyPNG 开发者 API）实现图像的压缩与大小调整。该工具旨在帮助开发者在 CI/CD 流程中自动化优化图像资源，减小文件体积的同时保持视觉质量。

核心功能

• 图像压缩：利用 Tinify API 对图像进行高效压缩，显著减小文件大小
• 图像调整：支持调整图像尺寸（如缩放、裁剪等），满足不同场景的尺寸需求
• GitHub Actions 集成：无缝融入 GitHub 工作流，实现图像优化的自动化执行

使用场景

适用于需要在软件开发流程中自动优化图像资源的场景，包括但不限于：

• 网站开发：优化页面图片，提升加载速度
• 移动应用开发：压缩应用内图像资源，减小安装包体积
• 静态站点生成：处理博客、文档站点中的图片资源
• 内容管理系统：自动优化用户上传的图像

使用方法

前提条件

1. 从 TinyPNG 开发者平台 获取 API 密钥（免费账户每月可处理 500 张图像）
2. 在 GitHub 仓库中配置名为 TINIFY_API_KEY 的 Secrets（用于安全存储 API 密钥）

配置参数

GitHub Actions 工作流示例

在仓库的 .github/workflows/ 目录下创建工作流文件（如 tinify-images.yml）：

yaml
name: Compress Images
on:
  push:
    paths:
      - 'images/**'  # 当 images 目录下文件变更时触发

jobs:
  tinify:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Compress and resize images
        uses: namoscato/action-tinify@v1  # 使用最新版本
        with:
          tinify_api_key: ${{ secrets.TINIFY_API_KEY }}
          path: 'images/**/*.{png,jpg,jpeg}'  # 处理 images 目录下的 png/jpg/jpeg 文件
          resize_method: 'fit'
          width: 800  # 目标宽度 800 像素
          height: 600  # 目标高度 600 像素

更多信息

访问 https://github.com/namoscato/action-tinify 获取完整文档和更新日志。