search

kurtosis-tech / kurtosis

A platform for packaging and launching ephemeral backend stacks with a focus on approachability for the average developer.
https://docs.kurtosistech.com/
Apache License 2.0
313 stars 42 forks source link

Be able to use `kurtosis.yaml` as well as `kurtosis.yml` for path def #1887

Open barnabasbusa opened 7 months ago

barnabasbusa commented 7 months ago

What's your CLI version?

Description & steps to reproduce

There was an error interpreting Starlark code Evaluation error: kurtosis.yml is not found in the path of 'github.com/ethpandaops/dencun-devnets/network-configs/devnet-12'; files can only be accessed from Kurtosis packages. For more information, go to: https://docs.kurtosis.com/advanced-concepts/how-do-kurtosis-imports-work at [github.com/kurtosis-tech/ethereum-package/main.star:103:22]: run at [0:0]: upload_files

Error encountered running Starlark code.

Desired behavior

Would be ideal if kurtosis.yaml would also be checked, as sometimes people will use yaml instead of yml.

What is the severity of this bug?

Painful; this is causing significant friction in my workflow.

What area of the product does this pertain to?

CLI: the Command Line Interface

mieubrisse commented 7 months ago

Hey @barnabasbusa , I'd actually prefer not to do this. Rationale:

  1. It adds confusion about "which one is correct?" to both users and our tooling
  2. When there's two, we have to have a strategy to duplicate
  3. It's a very easy for users to rename, and the error says kurtosis.yml not found indicating to the user which they need

What do you think?

barnabasbusa commented 7 months ago

most users (including me) expect that yaml == yml

It took me about 20 mins finding out what it was missing, as I really didn't think that the file format was the issue.

If you see both, yaml and yml then you should throw an error, stating that it's not obvious which one should be used.

Either way issue #1700 specifically asks for not having this file altogether (which would be my preferred way for sure!)