-
-
Notifications
You must be signed in to change notification settings - Fork 422
Ignore __MACOSX folder in tool archives when launching core install
#2162
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
Conversation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@ ## master #2162 +/- ## ========================================== - Coverage 62.57% 62.55% -0.03% ========================================== Files 223 223 Lines 19462 19459 -3 ========================================== - Hits 12179 12172 -7 - Misses 6192 6196 +4 Partials 1091 1091
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
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! just a missing license header.
We should also update the documentation and explicitly say that in the archives the subdirectory __MACOSX is ignored.
BTW I can't really find a place where the archive format is specified, the only place where this topic is discussed is at the bottom of docs/package_index_json-specification.md:
Installation archive structure
The installation archives contain the Board support files.
Supported formats are
.zip,.tar.bz2, and.tar.gz. Starting from Arduino CLI >=0.30.0 support for.tar.xz, and
.tar.zsthas been added, by the way, if you want to keep compatiblity with older versions of Arduino IDE and Arduino
CLI we recommend using one of the older formats.The folder structure of the core archive is slightly different from the standard manually installed Arduino IDE 1.5+
compatible hardware folder structure. You must remove the architecture folder(e.g.,avrorarm), moving all the
files and folders within the architecture folder up a level.
the hint for "The folder structure of the core archive" is referred specifically for platform archives. So... I guess this documentation requires a bit of refactoring, maybe it's worth opening another issue.
0c67cf0 to
9e4e5e0
Compare
We should also update the documentation and explicitly say that in the archives the subdirectory
__MACOSXis ignored.BTW I can't really find a place where the archive format is specified, the only place where this topic is discussed is at the bottom of
docs/package_index_json-specification.md:Installation archive structure
The installation archives contain the Board support files.
Supported formats are.zip,.tar.bz2, and.tar.gz. Starting from Arduino CLI >=0.30.0 support for.tar.xz, and
.tar.zsthas been added, by the way, if you want to keep compatiblity with older versions of Arduino IDE and Arduino
CLI we recommend using one of the older formats.
The folder structure of the core archive is slightly different from the standard manually installed Arduino IDE 1.5+
compatible hardware folder structure. You must remove the architecture folder(e.g.,avrorarm), moving all the
files and folders within the architecture folder up a level.the hint for "The folder structure of the core archive" is referred specifically for platform archives. So... I guess this documentation requires a bit of refactoring, maybe it's worth opening another issue.
We'll be taking care to improve docs in a separate PR. Tracking on #2167 🚀
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
This ignore
__MACOSXautogenerated folder inside the archives. When we launch thecore installcommandif the downloaded archive, besides the root dir, contains also the __MACOSX we simply ignore that dir.
What is the current behavior?
If we encounter a
__MACOSXfolder we throw an error.What is the new behavior?
We ignore every
__MACOSXfolder when searching for the package root.Does this PR introduce a breaking change, and is titled accordingly?
nope
Other information
I've added a commit to propose a small refactoring feel free to revert it.