Image Resizer

GitHub Action to resize images (jpeg, png, webp, avif, tiff, gif, svg) from file/url

Description

Provides operations on resizing input images from a file or url (jpeg, png, webp, avif, tiff, gif, svg) by format parameters.

Inputs

`sourceData`

Optional JSON data source file with action parameters:

Complete parameters

[
    {
        "width": 150,
        "height": 250,
        "quality": 100,
        "formatType": "jpeg",
        "sourceFile": "./data/input.jpg",
        "targetPath": "./data",
        "targetFile": "output.jpg"
    },
    {
        "width": 250,
        "height": 250,
        "formatType": "png",
        "sourceFile": "./data/input2.png",
        "targetPath": "./data",
        "targetFile": "output2.png"
    },
    {
        "width": 350,
        "height": 350,
        "formatType": "jpeg",
        "sourceFile": "https://lunrjs.com/images/moon.jpg",
        "targetPath": "./data"
    }
]

Basic parameters

[
    {
        "width": 150,
        "height": 250,
        "formatType": "jpeg",
        "sourceFile": "./data/input.jpg",
        "targetPath": "./data"
    },
    {
        "width": 250,
        "height": 250,
        "formatType": "png",
        "sourceFile": "./data/input2.png",
        "targetPath": "./data"
    },
    {
        "width": 350,
        "height": 350,
        "formatType": "jpeg",
        "sourceFile": "https://lunrjs.com/images/moon.jpg",
        "targetPath": "./data"
    }
]

`width`

Required Target image width

`height`

Required Target image height

`quality`

Optional Target image quality (should be in range 0-100)

`formatType`

Required Target image format type (any from the list: heic, heif, avif, jpeg, png, raw, tiff, webp, gif)

`sourceFile`

Required Source input image file or url to fetch content from

`targetPath`

Required Target path to store processed image files

`targetFile`

Optional Target image file name (default sourceFile)

Outputs

`changed`

Image file processing operation status

`true`

When input image file successfully processed

`false`

When error occurred while processing input image file

Examples

- name: Resize images
  uses: alexrogalskiy/github-action-image-resizer@master
  with:
    prefix: '<!--views:marker:start-->\n'
    suffix: '\n<!--views:marker:end-->'
    sourceFile: './data/info.md'
    placeholder: '<!--views:marker:start-->[\s\S]*?<!--views:marker:end-->'
    replacement: '<p align="center" style="text-align:center;">Data Block</p>'

Running locally:

npm run start:action --action github-action-image-resizer --prefix '\n' --suffix '\n' --sourceFile './data/info.md' --placeHolder '[\s\S]*?' --replacement '<p align="center" style="text-align:center;">Data Block</p>'