maplibre/martin
1
1
Fork 0
mirror of https://github.com/maplibre/martin.git synced 2024-12-19 04:41:46 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fix: cargo publish warning about README (#960)

Browse Source 
**Description**
- When running `cargo publish -p martin`, the following warning was
displayed.
```shell
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**
- [x] 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
This commit is contained in:
D V 2023-10-24 23:16:31 +05:30 committed by GitHub
parent d9eb5fd174
commit 4c97b7c256
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
martin/Cargo.toml
View File

@ -14,7 +14,7 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
readme.workspace = true
readme = "README.md"
homepage.workspace = true
[package.metadata.deb]