diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 59ddddee..3451efc6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -47,3 +47,14 @@ repos: - id: flake8 exclude: cibuildwheel/resources/ additional_dependencies: [flake8-bugbear] + + +# The original pybind11 checks for a few C++ style items +- repo: local + hooks: + - id: disallow-caps + name: Disallow improper capitalization + language: pygrep + entry: PyBind|Numpy|Cmake|Github + types: + - markdown diff --git a/README.md b/README.md index 6b46c70e..c9add123 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Usage Example setup ------------- -To build manylinux, macOS, and Windows wheels on Github Actions, you could use this `.github/workflows/wheels.yml`: +To build manylinux, macOS, and Windows wheels on GitHub Actions, you could use this `.github/workflows/wheels.yml`: ```yaml name: Build @@ -337,7 +337,7 @@ _1 January 2021_ - 🛠 Added a patch for Pypy to ensure header files are available for building in a virtualenv. (#502) -- 🛠 Some preparatory work towards using cibuildwheel as a Github Action. +- 🛠 Some preparatory work towards using cibuildwheel as a GitHub Action. Check out [the FAQ](https://cibuildwheel.readthedocs.io/en/stable/faq/#option-1-github-action) for information on how to use it. We'll be fully updating the docs to this @@ -349,7 +349,7 @@ _21 December 2020_ - 🛠 Update dependencies, notably wheel==0.36.2 and pip==20.3.3, and CPython to their latest bugfix releases (#489) -- 📚 Switch to a Github example in the README (#479) +- 📚 Switch to a GitHub example in the README (#479) - 📚 Create Working Examples table, with many projects that use cibuildwheel (#474) - 📚 Import Working Examples table and Changelog to docs @@ -454,7 +454,7 @@ _8 July 2020_ _25 June 2020_ - 🐛 Fix "OSError: [WinError 17] The system cannot move the file to a different - disk drive" on Github Actions (#388, #389) + disk drive" on GitHub Actions (#388, #389) ### 1.5.0 @@ -468,7 +468,7 @@ _24 June 2020_ (#360, #358) - ✨ Added workaround to allow Python 3.5 on Windows to pull dependencies from pyproject.toml. (#358) -- 📚 Improved Github Actions examples and docs (#354, #362) +- 📚 Improved GitHub Actions examples and docs (#354, #362) - 🐛 Ensure pip wheel uses the specified package, and doesn't build a wheel from PyPI (#369) - 🛠 Internal changes: using pathlib.Path, precommit hooks, testing @@ -526,7 +526,7 @@ _2 May 2020_ _12 March 2020_ -- 🌟 Add support for building on Github Actions! Check out the +- 🌟 Add support for building on GitHub Actions! Check out the [docs](https://cibuildwheel.readthedocs.io/en/stable/setup/#github-actions) for information on how to set it up. (#194) - ✨ Add the `CIBW_BEFORE_TEST` option, which lets you run a command to diff --git a/docs/contributing.md b/docs/contributing.md index 329a355c..1307c8e5 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -111,7 +111,7 @@ bin/bump_version.py You'll be prompted to enter the new version number. Update the changelog when prompted. The script will create a 'bump version' commit and version tag. -Finally, cut the release and upload to PyPI/Github. +Finally, cut the release and upload to PyPI/GitHub. ```bash rm -rf dist diff --git a/docs/data/projects.yml b/docs/data/projects.yml index 37a3114d..b032fb67 100644 --- a/docs/data/projects.yml +++ b/docs/data/projects.yml @@ -1,7 +1,7 @@ # Fields: # name: required, printed name -# gh: Github repo (eventually a url: could be added for non-github projects) -# stars: Github repo (optional, if different from package, such as for Twisted) +# gh: GitHub repo (eventually a url: could be added for non-github projects) +# stars: GitHub repo (optional, if different from package, such as for Twisted) # os: Operating system list, [windows, apple, linux] (optional) # ci: [appveyor, github, azurepipelines, circleci, gitlab, travisci] (optional) # notes: (text, optional) diff --git a/docs/faq.md b/docs/faq.md index 74b44743..3ab9f8a4 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -71,13 +71,13 @@ tested, and an `arm64` wheel is not tested at all. cibuildwheel supports building non-native architectures on Linux, via emulation through the binfmt_misc kernel feature. The easiest way to use this -is via the [docker/setup-qemu-action][setup-qemu-action] on Github Actions or +is via the [docker/setup-qemu-action][setup-qemu-action] on GitHub Actions or [tonistiigi/binfmt][binfmt]. [setup-qemu-action]: https://github.com/docker/setup-qemu-action [binfmt]: https://hub.docker.com/r/tonistiigi/binfmt -Check out the following config for an example of how to set it up on Github +Check out the following config for an example of how to set it up on GitHub Actions. Once QEMU is set up and registered, you just need to set the `CIBW_ARCHS_LINUX` environment variable (or use the `--archs` option on Linux), and the other architectures are emulated automatically. @@ -105,7 +105,7 @@ Hopefully, this is a temporary situation. Once we have widely available Apple Si So far, only CPython 3.9 supports `universal2` and `arm64` wheels. -Here's an example Github Actions workflow with a job that builds for Apple Silicon: +Here's an example GitHub Actions workflow with a job that builds for Apple Silicon: > .github/workflows/build_macos.yml ```yml diff --git a/docs/setup.md b/docs/setup.md index b07a0744..934d782b 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -4,14 +4,14 @@ title: 'Setup' # GitHub Actions [linux/mac/windows] {: #github-actions} -To build Linux, Mac, and Windows wheels using Github Actions, create a `.github/workflows/build.yml` file in your repo. +To build Linux, Mac, and Windows wheels using GitHub Actions, create a `.github/workflows/build.yml` file in your repo. > build.yml ```yaml {% include "../examples/github-minimal.yml" %} ``` -Commit this file, and push to Github - either to your default branch, or to a PR branch. The build should start automatically. +Commit this file, and push to GitHub - either to your default branch, or to a PR branch. The build should start automatically. For more info on this file, check out the [docs](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions).