Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 17.56%. Comparing base (b1851ba) to head (44a1ecd).
⚠️ Report is 3 commits behind head on main.

@@            Coverage Diff            @@
##               main   #11065   +/-   ##
=========================================
  Coverage     17.56%   17.56%           
  Complexity    15533    15533           
=========================================
  Files          5909     5909           
  Lines        529013   529013           
  Branches      64605    64605           
=========================================
  Hits          92912    92912           
- Misses       425652   425653    +1     
+ Partials      10449    10448    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

looks good @jbampton , but how would enforcing this with github actions work? Will it refuse not optimised pictures or automatically compress them?

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

looks good @jbampton , but how would enforcing this with github actions work? Will it refuse not optimised pictures or automatically compress them?

From the official site: https://pre-commit.com/

"Git hook scripts are useful for identifying simple issues before submission to code review. We run our hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements. By pointing these issues out before code review, this allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks."

So pre-commit is designed to run on the developers local machine when running manually pre-commit run --all-files and also automatically on git commit. And these trivial issues like whitespace etc are found first on the devs machine before pushing up to GitHub for code review. Running it locally is best practice and speeds up development since you don't have to wait for the pre-commit GitHub action to fail. The devs on Sedona and Airflow all run pre-commit locally.

So we need to add some documentation somewhere about pre-commit, how to install it and work with it locally.

For this hook oxipng it just works on GitHub actions with a pass or fail. When running locally if the hook fails it does optimize the images and then you need to git add and git commit again. So we can still merge a PR if the oxipng hook fails if needed.

Some example docs we could add might be:

pre-commit

We run pre-commit with GitHub Actions so installation on
your local machine is currently optional.

The pre-commit configuration file
is in the repository root. Before you can run the hooks, you need to have pre-commit installed.

The hooks run when running git commit and also from the command line with pre-commit. Some of the hooks will auto
fix the code after the hooks fail whilst most will print error messages from the linters. If a hook fails the overall
commit will fail, and you will need to fix the issues or problems and git add and git commit again. On git commit
the hooks will run mostly only against modified files so if you want to test all hooks against all files and when you
are adding a new hook you should always run:

pre-commit run --all-files

Sometimes you might need to skip a hook to commit because the hook is stopping you from committing or your computer
might not have all the installation requirements for all the hooks. The SKIP variable is comma separated for two or
more hooks:

SKIP=codespell git commit -m "foo"

The same applies when running pre-commit:

SKIP=codespell pre-commit run --all-files

Occasionally you can have more serious problems when using pre-commit with git commit. You can use --no-verify to
commit and stop pre-commit from checking the hooks. For example:

git commit --no-verify -m "foo"

If you just want to run one hook for example just run the markdownlint hook:

pre-commit run markdownlint --all-files

@blueorangutan package

@jbampton a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

clgtm @jbampton This is good. I believe that cloudstack website (https://github.com/apache/cloudstack-www) would really benefit from this same change since it has a lot of images.

I will add oxipng now to the website with pre-commit. Thanks

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15042

@blueorangutan package

@jbampton a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

Packaging result [SF]: ✔️ el8 ✖️ el9 ✔️ debian ✖️ suse15. SL-JID 15066

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15074