Leverage Justfile to run CI locally and in ghac

[jorgehermo9]

I recently saw how https://github.com/facet-rs/facet runs its CI and I think I really liked it. What they do is to have a justfile with all the checks (clippy, test, etc) and then in CI they run the same just command you'd run in local.

Why is this useful? Right now, CI is kind of cumbersome for new users (myself included) and what I end doing is to upload the changes to the PR and use ghac CI as it is a lot more quicker (at least for me). I think having all CI checks in justfile and execute just ci in local environment to run all CI checks is very useful. And if CI runs the same checks via the same command, this means that local CI and ghac CI is always in-sync, because if we have the steps duplicated between ghac workflows and justfile, they will (inevitably) be out of sync as time passes and someone forgets to update both places.

Examples of this

Facet Justfile

https://github.com/facet-rs/facet/blob/41ae7479c85968355c96fdc8c2d6d81d4967e6e1/Justfile#L21

Facet Workfows

https://github.com/facet-rs/facet/blob/41ae7479c85968355c96fdc8c2d6d81d4967e6e1/.github/workflows/test.yml#L39

---

I think having all checks in a single local justfile will improve developer experience a lot

[Xuanwo]

I'm assuming that by "ghac," you mean "GitHub Action" rather than "GitHub Action Cache."

---

OpenDAL's CI is extremely complex, consisting of 320 jobs and involving many different environment setups. I doubt it's possible to replicate all of them locally across various platforms.

Even for the simplest checks, we use actions like crate-ci/[email protected] to cache binaries and speed up the CI, which also makes it difficult to reuse the same scripts locally. Simulating GitHub Actions locally is another major challenge.

However, I really appreciate your willingness to give this a try and help improve the developer experience. You're welcome to give it a shot!

[jorgehermo9]

Yes, sorry, I meant just Github Actions

Thanks for your thoughts on this, I understand the complexity now! @Xuanwo 😁

[erickguan]

@jorgehermo9 you might be interested in nektos/act. Act is a tool to run a GitHub Action locally. Act runs a container very similar to GitHub. To run act, you can provide an event (you can obtain one with REST API or webhooks) as well as credentials.

I know some developers prefer development and testing this way. Some developers prefer CI running checks for them.

[jorgehermo9]

Thank you very much @erickguan , I'll take a look into that!