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

Crates are published with the incorrect README #5756

Closed
andygrove opened this issue Mar 27, 2023 · 0 comments · Fixed by #7964
Closed

Crates are published with the incorrect README #5756

andygrove opened this issue Mar 27, 2023 · 0 comments · Fixed by #7964
Labels
bug Something isn't working

Comments

@andygrove
Copy link
Member

andygrove commented Mar 27, 2023

Describe the bug

All datafusion crates are being published with the same top-level README, instead of the per-crate README files.

For example, see https://crates.io/crates/datafusion-optimizer. The docs here should explain what the optimizer crate is for rather than give an overview of DataFusion.

When publishing the crates, I am seeing warnings like this:

warning: readme `../../README.md` appears to be a path outside of the package, but there is already a file named `README.md` in the root of the package. The archived crate will contain the copy in the root of the package. Update the readme to point to the path relative to the root of the package to remove this warning.

To Reproduce

No response

Expected behavior

No response

Additional context

This was caused by the following commit:

8b5c1c7

@andygrove andygrove added the bug Something isn't working label Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant