stevemar/image-deleter

image-deleter

镜像概述

image-deleter是一个轻量工具，旨在清理Git仓库中未被任何文件引用的图片文件（PNG、JPG、JPEG）。它通过git rm标记需删除的图片，支持容器运行、GitHub Action集成和本地执行三种模式，帮助开发者减少仓库体积，保持资源整洁。

核心功能

• 识别仓库中未被引用的图片文件
• 使用git rm标记删除无用图片
• 支持容器化运行、GitHub Action自动化流程和本地直接执行
• 可配置调试日志输出

使用场景

• 定期清理项目中遗留的无用图片资源
• 在CI/CD流程中集成自动化图片清理步骤
• 本地开发时快速移除未使用的图片文件

配置说明

若需启用调试日志，可在Dockerfile中添加以下配置后重新构建镜像：

Dockerfile
ENV DEBUG=true

部署示例

容器运行

在项目根目录执行以下命令：

bash
docker run -v `pwd`:/source stevemar/image-deleter:latest

GitHub Action集成

1. 创建GitHub Secret，键名为GH_TOKEN，值为GitHub API密钥
2. 在.github/workflows/目录下创建工作流文件（如clean-images.yml），内容如下：

yaml
on:
  push:
    branches:    
      - master

jobs:
  rm_old_images:
    runs-on: ubuntu-latest
    name: 清理未使用图片
    steps:
      - name: 拉取代码
        uses: actions/checkout@master
      - name: 执行图片清理
        uses: stevemar/image-deleter@v1.0.1
      - name: 创建PR
        uses: peter-evans/create-pull-request@v3
        with:
          token: ${{ secrets.GH_TOKEN }}
          commit-message: 移除未使用图片
          title: '[自动化PR] 移除未使用图片'
          body: |
            发现并移除了部分未被引用的图片
            
            [参考工具]: https://github.com/stevemar/image-deleter
      - name: 查看输出
        run: |
          echo "PR编号 - ${{ steps.cpr.outputs.pull-request-number }}"
          echo "PR链接 - ${{ steps.cpr.outputs.pull-request-url }}"

本地运行

克隆仓库或复制脚本后直接执行：

bash
./rm-images.sh