Optimize Images with a GitHub Action

Recently I tried using GitHub Actions, which is a great tool! Simply put, it can run your code, such as build processes, tests, and deployments. It's just a configuration file that can run any required code. There are many Actions in the GitHub Actions market that can do all kinds of work for you.

My goal is to run the code to optimize the image so that I don't have to worry about it anymore. Any image in the warehouse will be automatically optimized.

There is already an ready-made Action that can implement this function, that is Calibre's image-actions, which we will use in this article. You also need to make sure that the repository has Actions enabled. I know that in my main organization we only enable Actions on a per-repository basis, which is one of the options.

Then, create the configuration file in ./github/workflows/optimize-images.yml . You can configure this Action in this file. All Actions can have separate files if needed. I created it as a separate file because: (1) it only works when "pushing to pull request", so if you have other Actions running on different triggers, they won't mix well; (2) Here's the usage suggested in their documentation.

 name: Optimize image on: pull_request
jobs:
  build:
    name: calibreapp/image-actions
    runs-on: ubuntu-latest
    Steps:
      - name: Get the code base uses: actions/checkout@master

      - name: compressed image uses: calibreapp/image-actions@master
        with:
          githubToken: ${{ secrets.GITHUB_TOKEN }}

Now, if you create a pull request, you will see it run:

After successful run, it leaves a comment in the pull request explaining what it optimized:

It will also resubmit these files to the pull request, so if you want to continue working on the pull request, you will need to push again to get the optimized image.

I can view the auto-commit and see the difference:

I know how to merge PR after everything goes well:

Very cool. Is it particularly difficult to optimize pictures locally? Not difficult. But never have to think about it again is better? Yes. You take a little technical debt here, but reduce it elsewhere, which at least seems to me a very fair deal.

The above is the detailed content of Optimize Images with a GitHub Action. For more information, please follow other related articles on the PHP Chinese website!