From 6994d9be4f1ab8837ec4369c2f1d1fb2244b3ef6 Mon Sep 17 00:00:00 2001 From: Anatoli Babenia Date: Mon, 13 Jun 2022 20:25:55 +0300 Subject: [PATCH] Document `config-file`, and add `with:` into example https://github.com/pypa/cibuildwheel/blob/main/action.yml --- docs/setup.md | 7 +++---- examples/github-minimal.yml | 6 +++++- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 14070f38..5af62a5f 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -154,10 +154,9 @@ To build Linux, Mac, and Windows wheels using GitHub Actions, create a `.github/ {% include "../examples/github-minimal.yml" %} ``` - - You can use `env:` with the action just like you would with `run:`; you can - also use `with:` to set the command line options: `package-dir: .` and - `output-dir: wheelhouse` (those values are the defaults). + Use `env:` to pass [build options](options.md) and `with:` to set + `package-dir: .`, `output-dir: wheelhouse` and `config-file: ''` + locations (those values are the defaults). !!! tab "pipx" The GitHub Actions runners have pipx installed, so you can easily build in diff --git a/examples/github-minimal.yml b/examples/github-minimal.yml index fae40fc9..a4c4a13b 100644 --- a/examples/github-minimal.yml +++ b/examples/github-minimal.yml @@ -15,9 +15,13 @@ jobs: - name: Build wheels uses: pypa/cibuildwheel@v2.7.0 - # to supply options, put them in 'env', like: # env: # CIBW_SOME_OPTION: value + # ... + # with: + # package-dir: . + # output-dir: wheelhouse + # config-file: {package}/pyproject.toml - uses: actions/upload-artifact@v3 with: