`charm proof` throws an error on the new "docs" field in metadata.yaml

charmcraft
1

Hi,

As the subject suggests charm proof throws an error on the new docs field in metadata.yaml:

proof: E: Unknown root metadata field (docs)

This is with latest/stable. I’m not quite sure where to file a bug about that, and snap info suggested posting here for issues.

Thanks, Tom

2

That validation lives here in charm-tools. In preparation for metadata v2, we should probably just make it ignore any unknown fields; that’s also how Juju behaves.

3

Thanks, have proposed https://github.com/juju/charm-tools/pull/591/ to address this.

4

is charm proof going to be deprecated in favor of charmcraft analyze?

5

Yes, the charm tool in general is already considered deprecated in favor of charmcraft. That said, if you’re working with existing charms that you can’t readily convert to the new Operator Framework, then you will still need to use charm to build them.

1 Like