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 explicit include to gdal-src Cargo.toml #579

Merged
merged 1 commit into from
Oct 24, 2024

Conversation

weiznich
Copy link
Contributor

This commit adds an explicit include to the Cargo.toml file of gdal-src to minimize the amount of code uploaded to crates.io. This reduces the uncompressed package size from >100MB to ~50MB. This is still larger than what's allowed by crates.io by default, but I know that it is possible to get an exception from these default limits by just asking with a good reason. Source code from an existing established open source project counts as good reason, so that's just something that needs to be done before publishing the first version.

The last time I had this problem the workflow was as follows:

  1. Publish an empty version
  2. Ask the crates.io team to bump the limit, e.g. via zulip
  3. Publish the real code.
  • I agree to follow the project's code of conduct.
  • I added an entry to CHANGES.md if knowledge of this change could be valuable to users.

@lnicola
Copy link
Member

lnicola commented Oct 23, 2024

Ouch, that's still a lot of MB, thanks! EDIT: nvm.

@lnicola
Copy link
Member

lnicola commented Oct 23, 2024

I can merge this, but it will be up to @jdroenner to publish the initial version.

@weiznich
Copy link
Contributor Author

cargo publish --dry-run also reports that at least the following Cargo.toml fields need to be added:

warning: manifest has no description, license, license-file, documentation, homepage or repository.

I can push a commit for that as well if you want.

@lnicola
Copy link
Member

lnicola commented Oct 23, 2024

Sure, let's add those.

@jdroenner
Copy link
Member

I can do the empty release later today. Anything i need to be aware of?

This commit adds an explicit include to the `Cargo.toml` file of
gdal-src to minimize the amount of code uploaded to crates.io. This
reduces the uncompressed package size from >100MB to ~50MB. This is
still larger than what's allowed by crates.io by default, but I know
that it is possible to get an exception from these default limits by
just asking with a good reason. Source code from an existing established
open source project counts as good reason, so that's just something that
needs to be done before publishing the first version.
@weiznich
Copy link
Contributor Author

I can do the empty release later today. Anything i need to be aware of?

No, not really. It's just that the database entry must exist, so that they can just add an exception manually.

@jdroenner
Copy link
Member

cargo publish --dry-run also reports that at least the following Cargo.toml fields need to be added:

warning: manifest has no description, license, license-file, documentation, homepage or repository.

I can push a commit for that as well if you want.

what should we fill in for homepage and documentation? A link to georust/gdal on github?

@lnicola
Copy link
Member

lnicola commented Oct 23, 2024

Same as the other crates, I guess?

@jdroenner
Copy link
Member

i created the empty crate: https://crates.io/crates/gdal-src

@lnicola lnicola merged commit d404a49 into georust:master Oct 24, 2024
16 checks passed
@lnicola
Copy link
Member

lnicola commented Oct 24, 2024

Turns out this was much too optimistic 😔.

@lnicola
Copy link
Member

lnicola commented Oct 29, 2024

@jdroenner @weiznich did any of you write to the crates.io team? Should I send an email?

@weiznich
Copy link
Contributor Author

weiznich commented Oct 29, 2024

I did not write them yet. In my experience the fastest way to reach them is via Zulip: https://rust-lang.zulipchat.com/#narrow/channel/318791-t-crates-io

I can write them a message there if that desired.

@lnicola
Copy link
Member

lnicola commented Oct 29, 2024

I've just sent an email, that's the preferred option.

@lnicola
Copy link
Member

lnicola commented Oct 30, 2024

Looks like we got the limit bumped to 50 MB compressed, which is hopefully enough (I think we're at 12 MB, even after #580).

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

Successfully merging this pull request may close these issues.

3 participants