0xPolygon / kurtosis-cdk

A Kurtosis package that deploys a private, portable, and modular Polygon CDK devnet
https://docs.polygon.technology/cdk
Apache License 2.0
29 stars 47 forks source link

chore: update tool check script #110

Closed leovct closed 2 months ago

leovct commented 2 months ago

Description

Update the tool check script to make sure users have installed the required versions of kurtosis and docker. It is easy to have the wrong combination of versions, which unfortunately makes our package unusable...

This PR also updates the bug report template to ask users to run the tool check script.

Tests

Before updating kurtosis to the latest version...

$ ./scripts/tool_check.sh
Checking that you have the necessary tools to deploy the Kurtosis CDK package...
❌ kurtosis 0.88.19 is installed, but only version 0.89 is supported.

After updating kurtosis...

$ ./scripts/tool_check.sh
Checking that you have the necessary tools to deploy the Kurtosis CDK package...
✅ kurtosis 0.89.3 is installed, meets the requirement (=0.89).
✅ docker 26.0.0 is installed, meets the requirement (>=24.7).

You might as well need the following tools to interact with the environment...
✅ jq 1.7.1 is installed.
✅ yq 3.2.3 is installed, meets the requirement (>=3.2).
✅ cast 0.2.0 is installed.
✅ polycli v0.1.43-1-gd122be7 is installed.

🎉 You are ready to go!

References (if applicable)

https://github.com/0xPolygon/polygon-docs/discussions/419#discussioncomment-9338299

sonarcloud[bot] commented 2 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud