From eda3dc1a4f1fa047778f18b6c4a9e919b043751a Mon Sep 17 00:00:00 2001 From: Yannick Jadoul Date: Tue, 10 Dec 2019 14:57:25 +0100 Subject: [PATCH] Moving Azure, AppVeyor, and CircleCI minimal examples in docs also to their own file under examples/ --- .../mkdocs_include_markdown_plugin/plugin.py | 6 +- docs/setup.md | 87 +------------------ examples/appveyor-minimal.yml | 15 ++++ examples/azure-pipelines-minimal.yml | 35 ++++++++ examples/circleci-minimal.yml | 38 ++++++++ examples/travis-ci-minimal.yml | 2 +- examples/travis-ci-test-and-deploy.yml | 1 - 7 files changed, 97 insertions(+), 87 deletions(-) create mode 100644 examples/appveyor-minimal.yml create mode 100644 examples/azure-pipelines-minimal.yml create mode 100644 examples/circleci-minimal.yml diff --git a/docs/mkdocs_include_markdown_plugin/mkdocs_include_markdown_plugin/plugin.py b/docs/mkdocs_include_markdown_plugin/mkdocs_include_markdown_plugin/plugin.py index 0060eec5..55fadf2f 100644 --- a/docs/mkdocs_include_markdown_plugin/mkdocs_include_markdown_plugin/plugin.py +++ b/docs/mkdocs_include_markdown_plugin/mkdocs_include_markdown_plugin/plugin.py @@ -42,7 +42,11 @@ class ImportMarkdownPlugin(mkdocs.plugins.BasePlugin): with io.open(file_path_abs, encoding='utf8') as f: text_to_include = f.read() - + + # Allow good practice of having a final newline in the file + if text_to_include.endswith('\n'): + text_to_include = text_to_include[:-1] + return text_to_include diff --git a/docs/setup.md b/docs/setup.md index 2c1ed02c..01580747 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -8,39 +8,7 @@ Using Azure pipelines, you can build all three platforms on the same service. Cr > azure-pipelines.yml ```yaml -jobs: -- job: linux - pool: {vmImage: 'Ubuntu-16.04'} - steps: - - task: UsePythonVersion@0 - - bash: | - python -m pip install --upgrade pip - pip install cibuildwheel==1.1.0 - cibuildwheel --output-dir wheelhouse . - - task: PublishBuildArtifacts@1 - inputs: {pathtoPublish: 'wheelhouse'} -- job: macos - pool: {vmImage: 'macOS-10.13'} - steps: - - task: UsePythonVersion@0 - - bash: | - python -m pip install --upgrade pip - pip install cibuildwheel==1.1.0 - cibuildwheel --output-dir wheelhouse . - - task: PublishBuildArtifacts@1 - inputs: {pathtoPublish: 'wheelhouse'} -- job: windows - pool: {vmImage: 'vs2017-win2016'} - steps: - - task: UsePythonVersion@0 - - script: choco install vcpython27 -f -y - displayName: Install Visual C++ for Python 2.7 - - bash: | - python -m pip install --upgrade pip - pip install cibuildwheel==1.1.0 - cibuildwheel --output-dir wheelhouse . - - task: PublishBuildArtifacts@1 - inputs: {pathtoPublish: 'wheelhouse'} +{% include "../examples/azure-pipelines-minimal.yml" %} ``` Commit this file, enable building of your repo on Azure Pipelines, and push. @@ -68,44 +36,7 @@ To build Linux and Mac wheels on CircleCI, create a `.circleci/config.yml` file > .circleci/config.yml ```yaml -version: 2 - -jobs: - linux-wheels: - working_directory: ~/linux-wheels - docker: - - image: circleci/python:3.6 - steps: - - checkout - - setup_remote_docker - - run: - name: Build the Linux wheels. - command: | - pip install --user cibuildwheel==1.1.0 - cibuildwheel --output-dir wheelhouse - - store_artifacts: - path: wheelhouse/ - - osx-wheels: - working_directory: ~/osx-wheels - macos: - xcode: "10.0.0" - steps: - - checkout - - run: - name: Build the OS X wheels. - command: | - pip install --user cibuildwheel==1.1.0 - cibuildwheel --output-dir wheelhouse - - store_artifacts: - path: wheelhouse/ - -workflows: - version: 2 - all-tests: - jobs: - - linux-wheels - - osx-wheels +{% include "../examples/circleci-minimal.yml" %} ``` Commit this file, enable building of your repo on CircleCI, and push. @@ -122,19 +53,7 @@ To build Linux and Windows wheels on AppVeyor, create an `appveyor.yml` file in > appveyor.yml ```yaml -image: - - Ubuntu - - Visual Studio 2015 -build_script: - # windows - - cmd: pip install cibuildwheel==1.1.0 - - cmd: cibuildwheel --output-dir wheelhouse - # linux - - sh: "${HOME}/.localpython3.7.4/bin/python3 -m pip install cibuildwheel==1.1.0" - - sh: "${HOME}/.localpython3.7.4/bin/python3 -m cibuildwheel --output-dir wheelhouse" -artifacts: - - path: "wheelhouse\\*.whl" - name: Wheels +{% include "../examples/appveyor-minimal.yml" %} ``` Commit this file, enable building of your repo on AppVeyor, and push. diff --git a/examples/appveyor-minimal.yml b/examples/appveyor-minimal.yml new file mode 100644 index 00000000..b0503233 --- /dev/null +++ b/examples/appveyor-minimal.yml @@ -0,0 +1,15 @@ +image: + - Ubuntu + - Visual Studio 2015 + +build_script: + # windows + - cmd: pip install cibuildwheel==1.1.0 + - cmd: cibuildwheel --output-dir wheelhouse + # linux + - sh: "${HOME}/.localpython3.7.4/bin/python3 -m pip install cibuildwheel==1.1.0" + - sh: "${HOME}/.localpython3.7.4/bin/python3 -m cibuildwheel --output-dir wheelhouse" + +artifacts: + - path: "wheelhouse\\*.whl" + name: Wheels diff --git a/examples/azure-pipelines-minimal.yml b/examples/azure-pipelines-minimal.yml new file mode 100644 index 00000000..567d6302 --- /dev/null +++ b/examples/azure-pipelines-minimal.yml @@ -0,0 +1,35 @@ +jobs: +- job: linux + pool: {vmImage: 'Ubuntu-16.04'} + steps: + - task: UsePythonVersion@0 + - bash: | + python -m pip install --upgrade pip + pip install cibuildwheel==1.1.0 + cibuildwheel --output-dir wheelhouse . + - task: PublishBuildArtifacts@1 + inputs: {pathtoPublish: 'wheelhouse'} + +- job: macos + pool: {vmImage: 'macOS-10.13'} + steps: + - task: UsePythonVersion@0 + - bash: | + python -m pip install --upgrade pip + pip install cibuildwheel==1.1.0 + cibuildwheel --output-dir wheelhouse . + - task: PublishBuildArtifacts@1 + inputs: {pathtoPublish: 'wheelhouse'} + +- job: windows + pool: {vmImage: 'vs2017-win2016'} + steps: + - task: UsePythonVersion@0 + - script: choco install vcpython27 -f -y + displayName: Install Visual C++ for Python 2.7 + - bash: | + python -m pip install --upgrade pip + pip install cibuildwheel==1.1.0 + cibuildwheel --output-dir wheelhouse . + - task: PublishBuildArtifacts@1 + inputs: {pathtoPublish: 'wheelhouse'} diff --git a/examples/circleci-minimal.yml b/examples/circleci-minimal.yml new file mode 100644 index 00000000..053966d9 --- /dev/null +++ b/examples/circleci-minimal.yml @@ -0,0 +1,38 @@ +version: 2 + +jobs: + linux-wheels: + working_directory: ~/linux-wheels + docker: + - image: circleci/python:3.6 + steps: + - checkout + - setup_remote_docker + - run: + name: Build the Linux wheels. + command: | + pip install --user cibuildwheel==1.1.0 + cibuildwheel --output-dir wheelhouse + - store_artifacts: + path: wheelhouse/ + + osx-wheels: + working_directory: ~/osx-wheels + macos: + xcode: "10.0.0" + steps: + - checkout + - run: + name: Build the OS X wheels. + command: | + pip install --user cibuildwheel==1.1.0 + cibuildwheel --output-dir wheelhouse + - store_artifacts: + path: wheelhouse/ + +workflows: + version: 2 + all-tests: + jobs: + - linux-wheels + - osx-wheels diff --git a/examples/travis-ci-minimal.yml b/examples/travis-ci-minimal.yml index f1abc204..e71772b7 100644 --- a/examples/travis-ci-minimal.yml +++ b/examples/travis-ci-minimal.yml @@ -19,4 +19,4 @@ install: script: # build the wheels, put them into './wheelhouse' - - python -m cibuildwheel --output-dir wheelhouse \ No newline at end of file + - python -m cibuildwheel --output-dir wheelhouse diff --git a/examples/travis-ci-test-and-deploy.yml b/examples/travis-ci-test-and-deploy.yml index 9a31da96..2609921f 100644 --- a/examples/travis-ci-test-and-deploy.yml +++ b/examples/travis-ci-test-and-deploy.yml @@ -74,4 +74,3 @@ env: global: - TWINE_USERNAME=joerick # Note: TWINE_PASSWORD is set in Travis settings -