Improved lint check speed

[himanshu007-creator]

Fixes

Fixes Addresses #236

Description

Technical details

Tests

Screenshots

Checklist

• My pull request has a descriptive title (not a vague title like Update index.md).
• My pull request targets the default branch of the repository (main or master).
• My commit messages follow best practices.
• My code follows the established code style of the repository.
• I added or updated tests for the changes I made (if applicable).
• I added or updated documentation (if applicable).
• I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

[dhruvkb]

Checks are passing so I have reason to believe the changes to the lint check worked.

But the check still took an inordinate amount of time.

[kevholmes]

Looking at the Actions log for this check, I see the linting step is taking over three minutes. Reviewing integration-tests.yml I have a few thoughts:

You are using pipenv here to install pre-commit. I believe pre-commit sets up virtual envs itself. Within the log it says things like "this environment will be reused.." but really that's if you are running it locally. There is a GitHub Action for pre-commit that will set up a environment and cache it for you - reducing a good amount of runtime.

If you really want to use pipenv, it looks like there is also a way to cache it and re-use it per run, which could also save you some execution time by skipping all the downloading and setup cycles.

Within your Tests check you've got a docker caching step that takes over two minutes - I noticed you are using a community provided action to handle image caching in Actions. There is now a caching layer provided to docker actions via the GitHub API that can be used to accomplish this without extra dependencies or steps.

[dhruvkb]

Apart from @kevholmes's fantastic ideas, this might help speed things along.

[kevholmes]

Linter check looks waay better @dhruvkb, 43 seconds - awesome!

[dhruvkb]

The speed improvements are very welcome @himanshu007-creator! I'm thinking of keeping #236 around to test if @kevholmes's suggestions (#237 (comment)) can improve the state of linting (and testing) further.