actions/compress-images

ivuorinen/actions/compress-images

Compress Images

Description

Compress images on demand (workflow_dispatch), and at 11pm every Sunday (schedule).

Inputs

name	description	required	default
token	GitHub token for authentication	false	${{ github.token }}
username	GitHub username for commits	false	github-actions
email	GitHub email for commits	false	github-actions@github.com
working-directory	Directory containing images to compress	false	.
image-quality	JPEG compression quality (0-100)	false	85
png-quality	PNG compression quality (0-100)	false	95
ignore-paths	Paths to ignore during compression (glob patterns)	false	node_modules/**,dist/**,build/**

Outputs

name	description
images_compressed	Whether any images were compressed (boolean)
compression_report	Markdown report of compression results

Runs

This action is a composite action.

Usage

- uses: ivuorinen/actions/compress-images@main
  with:
    token:
    # GitHub token for authentication
    #
    # Required: false
    # Default: ${{ github.token }}

    username:
    # GitHub username for commits
    #
    # Required: false
    # Default: github-actions

    email:
    # GitHub email for commits
    #
    # Required: false
    # Default: github-actions@github.com

    working-directory:
    # Directory containing images to compress
    #
    # Required: false
    # Default: .

    image-quality:
    # JPEG compression quality (0-100)
    #
    # Required: false
    # Default: 85

    png-quality:
    # PNG compression quality (0-100)
    #
    # Required: false
    # Default: 95

    ignore-paths:
    # Paths to ignore during compression (glob patterns)
    #
    # Required: false
    # Default: node_modules/**,dist/**,build/**