From 8f9a68fe94f4f1ae834a55a6bba7a86d8fab934a Mon Sep 17 00:00:00 2001 From: Joe Rickerby Date: Thu, 12 Mar 2020 19:46:58 +0000 Subject: [PATCH] Improve setup docs for Github actions --- docs/setup.md | 28 ++++++++++++++-------------- examples/github-minimal.yml | 7 ++++++- 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index 84a9b81c..f8b201ed 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -2,9 +2,22 @@ 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. + +> 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. + +For more info on this file, check out the [docs](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions). + # Azure Pipelines [linux/mac/windows] {: #azure-pipelines} -Using Azure pipelines, you can build all three platforms on the same service. Create a `azure-pipelines.yml` file in your repo. +To build Linux, Mac, and Windows wheels on Azure Pipelines, create a `azure-pipelines.yml` file in your repo. > azure-pipelines.yml ```yaml @@ -65,19 +78,6 @@ AppVeyor will store the built wheels for you - you can access them from the proj For more info on this config file, check out the [docs](https://www.appveyor.com/docs/). -# GitHub Actions [linux/mac/windows] {: #github-actions} - -Using GitHub Actions, you can build all three platforms on the same service. Create a `./github/workflows/build.yml` file in your repo. - -> build.yml -```yaml -{% include "../examples/github-minimal.yml" %} -``` - -Commit this file, enable building of your repo on GitHub Actions, and push. - -For more info on this file, check out the [docs](https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions). - > ⚠️ Got an error? Check the [FAQ](faq.md).