CopilothenryiiiHenry Schreinercopilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>* Initial plan * Add mkdocs-intersphinx plugin to generate objects.inv for intersphinx linking Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Add options.md comments to schema generator Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Plan intersphinx marker fix Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Add Python 3.12 marker to mkdocs-intersphinx Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Revert schema comment metadata changes Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: henryiii <4616906+henryiii@users.noreply.github.com> Co-authored-by: Henry Schreiner <HenrySchreinerIII@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
---
|
|
title: Home
|
|
ref: index
|
|
---
|
|
|
|
# cibuildwheel
|
|
|
|
{%
|
|
include-markdown "../README.md"
|
|
start="<!--intro-start-->"
|
|
end="<!--intro-end-->"
|
|
%}
|
|
|
|
To get started, head over to the [setup guide](setup.md).
|
|
|
|
How it works
|
|
------------
|
|
|
|
This diagram summarises the steps that cibuildwheel takes on each platform to build your package's wheels.
|
|
|
|
{%
|
|
include "diagram.html"
|
|
%}
|
|
|
|
This isn't exhaustive, for a full list of the things cibuildwheel can do, check the [options](options.md) page.
|
|
|
|
!!! warning "A note on security"
|
|
Building and testing wheels executes arbitrary code from your project and its dependencies. Although cibuildwheel uses OCI containers and Pyodide for some builds, these provide no security guarantees - the code you're building and testing has full access to the environment that's invoking cibuildwheel.
|
|
|
|
If you cannot trust all the code that's pulled in, maintain good security hygiene: keep the job that builds distributions separate from the job that uploads them to PyPI, handle secrets and credentials with care and rotate them regularly, and follow the principle of least privilege when granting permissions. Do not store sensitive data on CI runners.
|