Skip to content

1.2.0

Choose a tag to compare

@benschwarz benschwarz released this 25 Aug 03:03
· 67 commits to main since this release

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