forked fromamcewen/HttpClient
- Notifications
You must be signed in to change notification settings - Fork171
Remove superfluous and broken manifest file#133
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
`library.json` is PlatformIO's native library manifest file but Arduino's `library.properties` is also supported byPlatformIO:https://docs.platformio.org/en/latest/librarymanager/creating.html#creating-libraryThe `library.json` file was missing the required `version` field:https://docs.platformio.org/en/latest/librarymanager/config.html#versionAlthough it could be added, experience with other libraries indicates that it is not really realistic to expect twomanifest files to be properly maintained.Since the Arduino development software and the Arduino Library Manager requires `library.properties`, if we are to haveonly one the choice of keeping `library.properties` and removing `library.json` is clear.
aentinger approved these changesApr 25, 2022
aentinger left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
LGTM 👍 Thank you@per1234 🚀
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
topic: infrastructureRelated to project infrastructure type: imperfectionPerceived defect in any part of project
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
library.json
is PlatformIO's native library manifest file but Arduino'slibrary.properties
is also supported by PlatformIO:https://docs.platformio.org/en/latest/librarymanager/creating.html#creating-library
The
library.json
file was missing the requiredversion
field:https://docs.platformio.org/en/latest/librarymanager/config.html#version
Although it could be added, experience with other libraries (arduino-libraries/NTPClient#152) indicates that it is not really realistic to expect two manifest files to be properly maintained.
Sincethe Arduino development software and theArduino Library Manager require
library.properties
, if there is to be only one then it must belibrary.properties
that is kept andlibrary.json
that is removed.