Skip to content

Fix sdist include to ship CHANGES.md after changelog rename#3685

Open
kobihikri wants to merge 1 commit into
pallets:mainfrom
kobihikri:fix-sdist-changelog-include
Open

Fix sdist include to ship CHANGES.md after changelog rename#3685
kobihikri wants to merge 1 commit into
pallets:mainfrom
kobihikri:fix-sdist-changelog-include

Conversation

@kobihikri

@kobihikri kobihikri commented Jul 12, 2026

Copy link
Copy Markdown

#3559 renamed CHANGES.rst to CHANGES.md, but the [tool.flit.sdist] include list in pyproject.toml still references the old name. Flit silently skips include patterns that match nothing, so sdists no longer contain the changelog, and building the docs from an sdist fails because docs/changes.md includes ../CHANGES.md.

Verified after the change: uv build --sdist produces a tarball containing CHANGES.md, and sphinx-build -E -W from the extracted sdist passes again.

@davidism davidism closed this Jul 12, 2026
@kobihikri

Copy link
Copy Markdown
Author

Hi @davidism

Why was the PR closed? ...

I've reproduced the issue ...

@davidism

Copy link
Copy Markdown
Member

This appears to be AI generated. Did you use AI to generate this PR?

@kobihikri

kobihikri commented Jul 12, 2026 via email

Copy link
Copy Markdown
Author

@kobihikri

Copy link
Copy Markdown
Author

@davidism
And I have the workspace I reproduced open and am free to go on a live call if it's needed ...
They always say to start contributing small, so I picked the smallest possible thing I found that's broken ... and fixed it ...

@davidism davidism reopened this Jul 12, 2026
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.

2 participants