Warn user about .yml config file extension

[onnimonni]

Hey,

I spent way too much time to debug my environment and it turned out that the reason was that I had added my config into .sops.yml instead of .sops.yaml.

# This is not working
$ sops secrets/server.yaml
config file not found, or has no creation rules, and no keys provided through command line options

# fix the problem
$ mv .sops.yml .sops.yaml                                                                                                                                                 
renamed '.sops.yml' -> '.sops.yaml'

# It works now
$ sops secrets/server.yaml

This is my first contribution into sops and I'm happy to hear feedback and improve this. Thanks in advance 🙇

[felixfontein]

Thanks for your contribution!

Personally I'm against this change. Having different config file names is usually more a source of confusion.

There's already a note in the documentation, though it's a bit hidden since there's no central configuration documentation so far: https://github.com/getsops/sops?tab=readme-ov-file#213using-sopsyaml-conf-to-select-kms-pgp-and-age-for-new-files

[onnimonni]

Personally I'm against this change. Having different config file names is usually more a source of confusion.

I think this is a good point and similarly as we have linting rules in the code it's fine if you and the rest of the team want to keep this convention in sops.

How about logging a warning instead if .sops.yml variant is found? Or throwing an error?

The warning would make it more obvious for the user that their config was found but .yml is not supported.

AFAIK most other software will allow both variants and I assume I will not be the last one to stumble for this.

EDIT: Clarified weird sentences 👍

[felixfontein]

How about logging a warning instead if .sops.yml variant is found? Or throwing an error?

I think it would be best to report a warning if SOPS needs a config file and doesn't find one, but does find a .sops.yml while searching for .sops.yaml. I think that helps already a lot and improves the failure message you'll get.

[onnimonni]

Sorry that it took so long and I'm definitely not golang expert but I think this should do it 👍

[felixfontein]

I created a new PR (#1820) which comes closer to what I'd prefer the warning to behave like, and which also compiles :) Thanks for your contribution though, I think this warning is really helpful!

[onnimonni]

Thanks @felixfontein 🙇! I'm very happy with the new error messages 👍