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

fix: bundle includes ephemeral and ignored files #781

Open
renancaraujo opened this issue Feb 27, 2023 · 7 comments
Open

fix: bundle includes ephemeral and ignored files #781

renancaraujo opened this issue Feb 27, 2023 · 7 comments
Assignees
Labels
customer:🦄 enhancement New feature or request

Comments

@renancaraujo
Copy link
Collaborator

renancaraujo commented Feb 27, 2023

Description

Mason's bundle (therefore publish too) include files ignored by .gitignore in the file.
This can lead to a handful of situations where local files are shipped within a brick that the user didn't intend to.
For example: very_good_flutter_plugin included several files under .dart_tool and .idea after running mason publish locally. See this diff.

Expected Behavior

It is necessary to provide a what to ignore .gitignored files or provide a species of .masonignore file to be placed within

@renancaraujo renancaraujo added the bug Something isn't working label Feb 27, 2023
@jigarfumakiya
Copy link

Hey @renancaraujo,

I hope you're doing well. I am trying to update my brick, but after updating my mason, I am encountering the following error:

Malformed bundle.
The README.md file contents cannot be the default value.

I'm not sure if this error is related to this issue, or if I'm missing something in the process. Could you please provide some guidance on how to resolve this issue? Any help would be greatly appreciated. Thank you!

@felangel
Copy link
Owner

felangel commented Feb 28, 2023

Hey @renancaraujo,

I hope you're doing well. I am trying to update my brick, but after updating my mason, I am encountering the following error:

Malformed bundle.
The README.md file contents cannot be the default value.

I'm not sure if this error is related to this issue, or if I'm missing something in the process. Could you please provide some guidance on how to resolve this issue? Any help would be greatly appreciated. Thank you!

Hi @jigarfumakiya that means you have default content in the README of your brick. Can you please make sure your brick’s README reflects your custom brick? If you’re still having trouble please provide a link to your brick and I’m happy to take a closer look 👍

Edit: I took a look at your brick and I believe you just need to remove or adjust the “Getting Started” section in your README since that section was autogenerated by mason.

@jigarfumakiya
Copy link

A change to the readme fixes the problem. @felangel, thank you for responding so quickly.

@alestiago
Copy link
Collaborator

@renancaraujo @felangel any updates to this issue? Would having a .masonignore solve this (similar to .gitignore or .pubignore)?

@alestiago
Copy link
Collaborator

Any updates here? I'm open to contribute with the .masonignore file.

@felangel
Copy link
Owner

felangel commented Jan 4, 2024

I think supporting a .brickignore similar to a .pubignore makes sense and am totally open to contributions, thanks! 🙏

@felangel felangel added enhancement New feature or request and removed bug Something isn't working labels Jan 4, 2024
@alestiago
Copy link
Collaborator

Can I get assigned? 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer:🦄 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants