eggs icon indicating copy to clipboard operation
eggs copied to clipboard

[egg.json] inconsistent configuration info in schema.json and docs.nest.land

Open nberlette opened this issue 2 years ago • 1 comments

The official schema.json file (0.3.10) lists the properties bump and checkAll.

However, on the docs.nest.land page neither of those fields are mentioned. The documentation instructs us to use releaseType and check. Which one is it?

Assuming one of the mentioned pairs is deprecated (as opposed to a crazy typo), I feel like the schema.json file should reflect the previous version as deprecated, making a reference to the current property names that should be used. The documentation site should do the same.

It's frustrating that I have to currently have to include both versions of the aforementioned properties, since I have not the slightest clue which is deprecated and which is current. I'm sure I can't be the only user affected by this.

Thank you.

nberlette avatar Oct 07 '22 18:10 nberlette

Upon further inspection, I just realized that the homepage and repository properties are also inconsistent in the same manner as above. In the schema.json it includes the repository property, but none named homepage. On the documentation site, it states homepage is "usually a link to a repository", but makes no mention of a property named repository.

🥴

nberlette avatar Oct 07 '22 19:10 nberlette