Skip to content

Build backend: Make preview default and add configuration docs #12804

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

Merged
merged 17 commits into from
May 5, 2025

Conversation

konstin
Copy link
Member

@konstin konstin commented Apr 10, 2025

Add configuration documentation for the build backend and make it the preview default.

The build backend should generally work with default configuration unless you want specific features such as flat layout or module renaming, there is only a dedicated configuration, but no concept or guide page for the build backend. Once the build backend is stable, we can update the guide documentation to explain that uv defaults to its own build backend, but other build backends are also supported.

The uv build backend becomes the default in preview, giving it more exposure from users and preparing it to make it the default proper. The current documentation retains warnings that the build backend is in preview.

To see current uses of uv_build on GitHub: https://github.com/search?q=path%3A**%2Fpyproject.toml+uv_build%3E%3D0&type=code

@konstin konstin added documentation Improvements or additions to documentation preview Experimental behavior labels Apr 10, 2025
Base automatically changed from konsti/build-backend-docs to main April 21, 2025 10:27
@konstin konstin force-pushed the konsti/build-backend-preview-default branch from c668649 to 521c8d7 Compare April 22, 2025 10:36
@konstin konstin force-pushed the konsti/build-backend-preview-default branch from 02dec3f to bdc8288 Compare April 25, 2025 08:12
@konstin
Copy link
Member Author

konstin commented Apr 25, 2025

I've addressed all comments, this is ready for another round.

@konstin konstin marked this pull request as ready for review April 25, 2025 08:21
Co-authored-by: Zanie Blue <[email protected]>
@konstin konstin deployed to release May 5, 2025 13:42 — with GitHub Actions Active
@konstin konstin enabled auto-merge (squash) May 5, 2025 13:43
@konstin konstin temporarily deployed to uv-test-publish May 5, 2025 13:44 — with GitHub Actions Inactive
@konstin konstin merged commit 5386701 into main May 5, 2025
105 checks passed
@konstin konstin deleted the konsti/build-backend-preview-default branch May 5, 2025 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation preview Experimental behavior
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants