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

Add an exclude field in library.properties specification // allows files exclusion for library build #9787

Closed
MonsieurV opened this issue Feb 20, 2020 · 2 comments
Labels
Component: Board/Lib Manager Boards Manager or Library Manager feature request A request to make an enhancement (not a bug fix)

Comments

@MonsieurV
Copy link

MonsieurV commented Feb 20, 2020

Hi,

Context: library with "extra" content

I'm using the library specification to publish a library to the Arduino Library.
I've recently added a build log section to my library, as part of the documentation.

Problem: extra content included in library zip, making it bulkier

These build logs contain many images, which are getting included with the rest of the library to the directory. The result is a library zip size inflation:
image

(See library profile)

This build logs directory was not intended to be published on the library directory / added to the final library zip.

Suggestion: add a mechanism for specifying files to be excluded from the library zip

Add an exclude field in the library.properties specification, allowing library publisher to define a list of files/files pattern to be excluded from the final library build. This would allows publisher to add extra content to their GitHub repositories without it to be systematically published along the library on the Arduino library directory.

Related: arduino/arduino-cli#990 #5688

@per1234 per1234 added Component: Board/Lib Manager Boards Manager or Library Manager feature request A request to make an enhancement (not a bug fix) labels Feb 20, 2020
@bengtmartensson
Copy link

Really useful feature -- how did we get by without it?

However, library.properties is a file that tells the user and his tools how to handle the library; information on how the library manager is extracting stuff from Git does not belong there. Possibly a new file?

Additionally, a positive version (i.e. include instead of exclude) may be more useful. Of course, offering both possibilities would be optimal.

@per1234
Copy link
Collaborator

per1234 commented Apr 2, 2021

Thanks to bengtmatensson for an explanation of how library.properties is not an ideal mechanism for this. I think the alternative proposal of using the standardized functionality already provided by Git will be a better approach so I'll close this in favor of that one: https://github.com/arduino/Arduino/issues/8478

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Board/Lib Manager Boards Manager or Library Manager feature request A request to make an enhancement (not a bug fix)
Projects
None yet
Development

No branches or pull requests

3 participants