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: cargo publish warning about README #960

Merged
merged 1 commit into from
Oct 24, 2023
Merged

fix: cargo publish warning about README #960

merged 1 commit into from
Oct 24, 2023

Conversation

DarhkVoyd
Copy link
Contributor

@DarhkVoyd DarhkVoyd commented Oct 23, 2023

Description

  • When running cargo publish -p martin, the following warning was displayed.
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.
  • Till the time of this PR, the issue was probably a bug with Cargo, in case of a project with a symlink readme linking to the workspace readme.

Changes Made

  • To avoid the warning until the issue is fixed with Cargo, the solution is by manually setting readme = "README.md" instead of readme.workspace = true.

Testing

  • I have tried running cargo publish -p martin for a few seconds, and hit Ctrl+C the moment it starts compiling. The above readme warning is no longer shown.

Closes: #914

@sharkAndshark
Copy link
Collaborator

I can't see that warning again. Approved : )

@nyurik nyurik merged commit 4c97b7c into maplibre:main Oct 24, 2023
18 checks passed
@nyurik
Copy link
Member

nyurik commented Oct 24, 2023

Thanks!

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.

Fix cargo publish warning about README
3 participants