Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
nberlette opened this issue Oct 7, 2022 · 1 comment

Comments

@nberlette
Copy link

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 nberlette changed the title [eggs.json] inconsistent configuration info in schema.json and docs.nest.land [egg.json] inconsistent configuration info in schema.json and docs.nest.land Oct 7, 2022
@nberlette
Copy link
Author

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.

🥴

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant