Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/imgbot/imgbot

An Azure Function solution to crawl through all of your image files in GitHub and losslessly compress them. This will make the file size go down, but leave the dimensions and quality untouched. Once it's done, ImgBot will open a pull request for you to review and merge. [email protected]
https://github.com/imgbot/imgbot

azure azure-functions bot code-quality compress-images dotnet-core github-app github-integration help-wanted image-compression image-optimization imagemagick optimize-images

Last synced: 3 days ago
JSON representation

Host: GitHub
URL: https://github.com/imgbot/imgbot
Owner: imgbot
License: mit
Created: 2017-08-24T15:31:50.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-08-19T20:56:56.000Z (4 months ago)
Last Synced: 2024-10-29T15:43:19.297Z (about 2 months ago)
Topics: azure, azure-functions, bot, code-quality, compress-images, dotnet-core, github-app, github-integration, help-wanted, image-compression, image-optimization, imagemagick, optimize-images
Language: C#
Homepage: https://imgbot.net/
Size: 7.71 MB
Stars: 1,244
Watchers: 42
Forks: 272
Open Issues: 69
Metadata Files:
- Readme: README.md
- Contributing: Docs/contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Imgbot

Imgbot crawls all your image files in GitHub and submits pull requests after applying a loss less compression.
This will make the file size go down, but leave the dimensions and quality just as good.

![screenshot](https://imgbot.net/images/screen.png?cache=2)

## Configuration

Imgbot supports optional configuration through a `.imgbotconfig` json file.
This is not a required step to using Imgbot and is only for more advanced scenarios.
This file should be placed in the root of the repository and set to your liking.

```
{
"schedule": "daily", // daily|weekly|monthly
"ignoredFiles": [
"*.jpg", // by extension
"image1.png", // by filename
"public/special_images/*", // by folderpath
],
"aggressiveCompression": "true", // true|false
"compressWiki": "true", // true|false
"minKBReduced": 500 // set reduction threshold (default to 10),
"prTitle" : "Compressed images", // set pull request title
// set the pull request body, supports any valid github markdown
// {optimization_ratio} display a message containing the optimization ratio
// {optimization_details} display the table containing the optimization details
"prBody" : " Text before optimization ratio {optimization_ratio} Text after optimization ratio
Text before optimization details {optimization_details} Text after optimization details",

}
```

The following are the currently supported parameters.
If there are any configuration settings you would like to see changed or supported,
please feel free to open an issue here in the repo or shoot an email over
to [email protected]

**schedule**

- Optional
- Accepts: daily|weekly|monthly
- Limits the PRs from Imgbot to once a day, once a week, or once a month respectively
- The default behavior is to receive Imgbot PRs as images require optimization

**ignoredFiles**

- Optional
- Accepts the syntax for searchPattern on [Directory.EnumerateFiles()](https://docs.microsoft.com/en-us/dotnet/api/system.io.directory.enumeratefiles)
- Limits the images optimized by Imgbot by essentially ignoring them
- When ignoring by file name no path is necessary, when ignoring by folder name full path from root is necessary

**aggressiveCompression**

- Optional
- Accepts: true|false
- Opt in to use lossy compression algorithms
- The default behaviour without this setting is loss less compression

**compressWiki**

- Optional
- Accepts: true|false
- Opt in to also compress wiki repo
- Example: `https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git`
- The default behaviour is opt out

**minKBReduced**

- Optional
- Accepts only numbers as input (e.g. `"minKBReduced": 500` for a 500 KB threshold)
- Can be used to limit the frequency of PRs Imgbot will open over time
- The default setting is 10

**prTitle**

- Optional
- Available only for paid plans
- Accepts only strings as input (e.g. `"prTitle": "My title"`)
- Can be used to display any custom pull request title
- The default setting is "[ImgBot] Optimize images"

**prBody**

- Optional
- Available only for paid plans
- Accepts only strings as input
- (e.g. `"prBody": "Text before {optimization_ratio} Text after"`

`Text before {optimization_details} Text after"`)
- Can be used to display any custom pull request body, written using github [markdown](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
- Supports two magic tags: `{optimization_ratio} //displays the mean optimization ratio for all images`

`{optimization_details} //display the optimization details for every images`
- The default setting generates the body displayed [here](https://imgbot.net/images/screen.png?cache=2)

Find out more: https://imgbot.net/docs

## Contributing

All the code for Imgbot is available on GitHub. We will gladly accept contributions for the service, the website, and the documentation. This is where you can find out how to get set up to run locally as well as detailed information on exactly how Imgbot works.

https://imgbot.net/docs#contributing