# clear-image-action

**Repository Path**: yiyungent/clear-image-action

## Basic Information

- **Project Name**: clear-image-action
- **Description**: 🔧 Image detection. | 图片检测 | 清理未引用图片 | 删除未引用图片 | 检查引用的图片是否有效 | GitHub Actions
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-10
- **Last Updated**: 2022-02-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">clear-image-action</h1>

> 🔧 Image detection. | 图片检测 | GitHub Actions

[![repo size](https://img.shields.io/github/repo-size/yiyungent/clear-image-action.svg?style=flat)]()
[![LICENSE](https://img.shields.io/github/license/yiyungent/clear-image-action.svg?style=flat)](https://github.com/yiyungent/clear-image-action/blob/main/LICENSE)
[![QQ Group](https://img.shields.io/badge/QQ%20Group-894031109-deepgreen)](https://jq.qq.com/?_wv=1027&k=q5R82fYN)


> 注意: 本项目采用 `Star License + MIT License`, 你必须 Star 本项目 才能在你的仓库中运行本 GitHub Action

## 介绍

使用 `GitHub Action` 自动检测你仓库内 由于误删,图床失效等导致的引用无效,让你第一时间了解丢失了哪些图片;自动清理无用冗余垃圾图片,无需再手动管理图片, 清除无用图片。

## 功能

- [x] 自动扫描仓库指定文件夹, 发起 `Pull Request`: 图片扫描报告
- [x] 清理未引用图片
  - 以 `Pull Request` 形式发起, 只有你同意合并后, 清理才生效
- [x] 检查 引用的图片 是否有效
  - [x] 检查 引用的本地图片 是否存在
  - [x] 检查 引用的网络图片 是否有效 (200 非 404)

## 使用

### 创建 clear-image.yml

> .github/workflows/clear-image.yml

```yml
name: clear-image

on:
  push:
    branches: [main] # 注意更改为你的 branch, 例如 master

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source
        uses: actions/checkout@v2

      - name: Clear image
        uses: yiyungent/clear-image-action@main
        with:
          # 默认为空, 即为仓库根目录
          scan_directory: ""
          # 多个路径之间用 英文逗号 , 隔开, 用相对于仓库根目录的 相对路径
          ignore_paths: ""

```

## Screenshots

> 部分 `Pull Request` 截图

![](screenshots/1.png)


## Related Projects

- [yiyungent/coo: 🧰 .NET 自用CLI, 工具集](https://github.com/yiyungent/coo)    
  - 本项目 核心依赖


## Donate

clear-image-action is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing.

We accept donations through these channels:
- <a href="https://afdian.net/@yiyun" target="_blank">爱发电</a>

## Author

**clear-image-action** © [yiyun](https://github.com/yiyungent), Released under the [MIT](./LICENSE) License.<br>
Authored and maintained by yiyun with help from contributors ([list](https://github.com/yiyungent/clear-image-action/contributors)).

> GitHub [@yiyungent](https://github.com/yiyungent) Gitee [@yiyungent](https://gitee.com/yiyungent)