1.4.0: AVIF

In this release:

• Process & compress AVIF images

Note

Add avif extension to the paths stanza in your actions configuration yml:

on:
  pull_request:
    paths:
      - '**.jpg'
      - '**.jpeg'
      - '**.png'
      - '**.webp'
      - '**.avif'

If you have AVIF images in your repository, they will be processed by image-actions.

1.3.0

In this release:

✨ Only optimise new or changed images (#339)

• When your PR adds or updates images, image-actions will run on them
• When run manually, scheduled, or in the event of an error all images will be processed (uses pre 1.3.0 behavior)

Important

When updating from versions prior to 1.2.0, please update configuration:

      - name: Compress Images
        uses: calibreapp/image-actions@main
        with:
          # The `GITHUB_TOKEN` is automatically generated by GitHub and scoped only to the repository that is currently running the action. By default, the action can’t update Pull Requests initiated from forked repositories.
          # See https://docs.github.com/en/actions/reference/authentication-in-a-workflow and https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions
-         githubToken: ${{ secrets.GITHUB_TOKEN }}
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Other changes:

• Updated README with updated config
• Removed long-deprecated configuration method

Full Changelog: 1.2.0...1.3.0

1.2.0

1.2.0

It's been 5 years since the last release of image-actions. Image-actions was authored before GitHub Actions used YML, and before GitHub had packages like @actions/core, @actions/github and @octokit/action to ease authoring of Actions.

Since then, image-actions has been executed millions of times(!) and is used by a large number of people.

Personally, I'm not using image-actions often as I usually rely on image CDNs to optimise images on the fly. As a result of this, image-actions lagged on releases and fell behind on dependencies. Until today :-)

This maintenance release includes many changes and fixes, including:

• Make use of @actions/core, @actions/github & octokit/action instead of legacy lib code
• Updates all dependencies to latest
• Update to Node 22
• Runs TSC, Lint & Format check in CI
• Removes TSC build, replaces with Experimental Node TS type stripping
• Prepares for a more expected versioning & release process
• Adds @alexdupre's minPctChange configuration option (set to 5% by default)
• Drops dependencies where possible
• Changes default compression settings for better image visuals
• Throttles requests to GitHub, reducing failures for large change sets
• Limits to a maximum of 500 images changed per Pull Request
• Truncates markdown report to list a maximum of 25 images
• (Probably) supports ARM64 and other architectures (By switching to Docker build over 1 pre-built image)

Thanks to everyone who uses image-actions and community members who helped support up until now.

Important

When updating to 1.2.0, please update configuration:

      - name: Compress Images
        uses: calibreapp/image-actions@main
        with:
          # The `GITHUB_TOKEN` is automatically generated by GitHub and scoped only to the repository that is currently running the action. By default, the action can’t update Pull Requests initiated from forked repositories.
          # See https://docs.github.com/en/actions/reference/authentication-in-a-workflow and https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions
-         githubToken: ${{ secrets.GITHUB_TOKEN }}
+         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

@benschwarz

1.1.0: Merge pull request #45 from steveoh/patch-1

docs: clarify the docs

1.0.0

Update readme

Added overall stats

Added overall compression statistics to the pull request message

Initial release

0.0.2

Update readme

0.0.1

Added everything