Cache the Testkube binary in the GitHub Action

[rangoo94]

We should cache the Testkube binary using @actions/tool-cache. You may find an example in azure/setup-kubectl.

At the moment we are calling GitHub API each time, which results in the rate limit errors for frequent workflows.

[rangoo94]

Fixed with kubeshop/setup-testkube#4

[itsme2980]

Hi @devcatalin , @rangoo94 Thank you for the concise support regarding this feature. I've recently had the opportunity to review your implementation, and I'd like to share some comments from my perspective. This approach is only viable once Testkube is successfully installed within the GitHub Actions (GA) workflow. This means the cache is effective only when Testkube has been installed. There's a scenario where GitHub.io might impose rate limits, rejecting installation from anonymous access, rendering this caching implementation ineffective.

I propose we implement an additional feature: allowing users to define the GitHub.io Personal Access Token (PAT) within the action.yaml. This PAT could then be used to authorize with GitHub.io, overcoming potential rate-limiting issues. For more details about the token property I mentioned, you can refer to https://github.com/actions/setup-python.

The combination of a GitHub.io token and caching would be highly beneficial. 👍

[itsme2980]

Also, once the setup-testkube is executed successfully, I could not find the cache at https://<git-url>/<repo-org>/<repo-name>/actions/caches. In the build log, at Complete runner and Complete job I also couldn't find the message to store cache. Do you need any further details to help you able to trace this issue?

[rangoo94]

Hi @itsme2980!

Thank you, regarding the first proposal, I have added a new ticket for that - #4965.

When it comes to cache - you won't find the cache, as we are using built-in GitHub's mechanism for caching binaries, and it's working only on self-hosted workers (@actions/tool-cache). We cannot use the actual GH cache, as it's not possible from the action level.

If you want to avoid requests to the GH API, you may also use version parameter specifically - this way, the setup-testkube won't try to find the latest release using GH API, it will only download the binary.