Skip to content

fix: build error of README.md path #1368

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: build error of README.md path #1368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c494f15
fix: build errors due to README.md path in pyproject.toml
Mr-Sunglasses Aug 29, 2025
3ea2448
Merge branch 'master' into fix/build
Mr-Sunglasses Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions pyproject.toml
View file
Open in desktop
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

iirc having this in that directory was to work around a different maturin issue.

Does symlinking the README work?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope symlinking the README is now working.

❯ maturin sdist --manifest-path crates/typos-cli/Cargo.toml --out dist | xclip -sel clip
⚠️  Warning: `project.version` field is required in pyproject.toml unless it is present in the `project.dynamic` list
💥 maturin failed
  Caused by: Failed to read readme specified in pyproject.toml, which should be at /home/kanishk/Projects/OSS/typos/crates/typos-cli/README.md
  Caused by: failed to open file `/home/kanishk/Projects/OSS/typos/crates/typos-cli/README.md`: Symbolic link loop (os error 40)

Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[build-system]
requires = ["maturin>=1.9,<1.10"]
build-backend = "maturin"

[project]
name = "typos"
description = "Source Code Spelling Correction"
requires-python = ">=3.8"
keywords = [
"development", "spelling"
]
classifiers = [
"Environment :: Console",
"Intended Audience :: Developers",
"Topic :: Software Development",
"Operating System :: OS Independent",
"License :: OSI Approved :: MIT License",
"License :: OSI Approved :: Apache Software License",
"Programming Language :: Python",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Rust",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
]

readme = "README.md"

[project.urls]
Repository = "https://github.com/crate-ci/typos"
Documentation = "https://github.com/crate-ci/typos#typos"
Changelog = "https://github.com/crate-ci/typos/blob/master/CHANGELOG.md"
Releases = "https://github.com/crate-ci/typos/releases"

[tool.maturin]
module-name = "typos"
bindings = "bin"
Loading