Add Github Action cache to improve CI time

[duc-nx]

No description provided.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nexus-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 23, 2024 7:06pm

[slumber]

Note that current CI configuration already caches compile artifacts, from main branch test workflow:

... Restoring cache ...
Received 22[229](https://github.com/nexus-xyz/nexus-zkvm/actions/runs/10273767219/job/28429080317#step:3:239)8112 of 509254757 (43.7%), 211.6 MBs/sec
Received 478150656 of 509254757 (93.9%), 227.8 MBs/sec
Cache Size: ~486 MB (509254757 B)

It does appear to not work now, might be a misconfiguration issue or something else. Quick search gives https://github.com/actions/cache/blob/main/tips-and-workarounds.md#use-cache-across-feature-branches

Tearing out the whole thing isn't proper solution, as there's no guarantee it will not happen again (especially because two workflows function the same way).

Secondly, the whole CI configuration now looks very cluttered compared to main.

[duc-nx]

Hmm, I didn't know we have build cache, perhaps because I only look at build time in CI. When I made this PR, I notice the build time improve.
For example: the test-smoke and test-sdk usually take 8 to 10 minutes, now down to 5 to 7 minutes.

I separate the clippy, because this way we have code scanning features and can be viewed overtime in Github settings.
Other than that, I group a few build and check together, so they don't have to query the cache if they run separately.
Because the CI success is determined at the longest task (which is tesk-sdk and test-smoke), so by combing them together doesn't make the CI worst, IMO.

[duc-nx]

Updated the Cache and compare the test time between main and this branch:

• Main Add Nova Public Parameter benchmark for SDK (#267)
• This branch Add Github Action cache to improve CI time

Build time actually improved. (except tesk_smoke and test_sdk where we do a fresh build).

[yoichi-nexus]

Why is this sentence here? Depending on the reason, you might want the same sentence in .github/workflows/ci.yml.

[duc-nx]

This is not our script. We should leave it as is in so in the future we get a fresh new one instead of fixing it.

[sjudson]

This is just a caveat emptor that you're using third-party code on GH Actions and if something breaks it's not GHs fault. No harm in keeping it or removing it either way, but might make it easier to track down the provenance.

[yoichi-nexus]

This is not our script.

Let's add a link to the source. Also, what's the license of the source?

[duc-nx]

Idk, it's from the Github action item, and I just click on it and make minor modification.
I'm pretty sure it's open license, because there are plenty projects use this, although I don't have time to find the exact original license of this source.

[yoichi-nexus]

EDIT: Doesn't look ready to merge.

[duc-nx]

Close this PR due to no time to work on it anymore. Although the CI build is improved and Code scanning will be helpful to the project.