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

Exclude media/ (and maybe some other things) from crates.io package #230

Open
crumblingstatue opened this issue Jan 5, 2025 · 4 comments

Comments

@crumblingstatue
Copy link
Contributor

With #218 merged, repo performance is improved, but it might also be desirable to make the crates.io package as lean as possible as well.

Right now, it contains a 2 MB media folder.

Cargo.toml has ways to control what is included in a package, see https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields

@fluxxcode
Copy link
Owner

I think this breaks the readme on crates.io 🤔

@crumblingstatue
Copy link
Contributor Author

Ah, that's true.
This is personally why I prefer hosting things like screenshots outside of the package.
The crate size might get out of hand eventually if there are too many screenshots, and changelog images added.
Maybe at least the changelog images could be excluded from the crate.

@fluxxcode
Copy link
Owner

I'm currently considering generally removing all images from the CHANGELOG.md file and keeping the file only plain text. Images can then be used in the GitHub release.
Then we could keep all images from the readme inside the package and exclude all other images from the examples.

I'm also not sure whether Crates.io can handle the GIT LFS images in the README. I don't think so. So it needs to be adjusted again anyway.

@crumblingstatue
Copy link
Contributor Author

crumblingstatue commented Jan 6, 2025

I'm also not sure whether Crates.io can handle the GIT LFS images in the README. I don't think so. So it needs to be adjusted again anyway.

Well, since the crates.io package is just an archive, it would work as long as the images are present in the archive, regardless of how they are version tracked.

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

2 participants