BLD: fix typos and add comments on pitfalls

equinor · Apr 20, 2021 · 455bb6b · 455bb6b
1 parent ac87b5f
commit 455bb6b
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 7 deletions.
diff --git a/.github/workflows/ci-test-xtgeo-cibuildwheel.yml b/.github/workflows/ci-test-xtgeo-cibuildwheel.yml
@@ -1,5 +1,3 @@
-# Test building some cibuildwheel on pull requests (simplified testing)
-
 name: cibuildwheel
 
 on:
@@ -35,9 +33,9 @@ jobs:
         uses: actions/setup-python@v2
 
       - name: Install cibuildwheel
-        run: |
-          python -m pip install pip -U
-          python -m pip install wheel
+        run: >
+          python -m pip install pip -U &&
+          python -m pip install wheel &&
           python -m pip install cibuildwheel
 
       - name: Build wheels and test
@@ -93,6 +91,16 @@ jobs:
         run: |
           python -m cibuildwheel --output-dir wheelhouse
 
+  # pitfall for Windows, while this works for linux and macos:
+  # run: |
+  #    command1
+  #    command2
+  # it will not work for windows! Only command1 is executed; hence this syntax is
+  # replaced with:
+  # run: >
+  #     command1 &&
+  #     command2
+
   build_windows_cibuildwheel:
     name: CIBW python ${{ matrix.cibw_python }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}

diff --git a/.github/workflows/deploy-xtgeo-pypi.yml b/.github/workflows/deploy-xtgeo-pypi.yml
@@ -63,7 +63,7 @@ jobs:
         git clone --depth 1 https://github.com/equinor/xtgeo-testdata ../xtgeo-testdata
       CIBW_TEST_COMMAND: >
         pushd {project} &&
-        pytest tests --disable-warnings &&
+        pytest tests --disable-warnings
       CIBW_BUILD: ${{ matrix.cibw_python }}-macosx_x86_64
 
     strategy:
@@ -90,7 +90,8 @@ jobs:
 
       - name: Build wheels and test python 3.9
         if: matrix.cibw_python == 'cp39'
-        # note tests are a bit restricted due to missing pytables wheel
+        # note tests are a bit restricted due to missing pytables wheel; that is
+        # --ignore tests/test_well
         env:
           CIBW_TEST_COMMAND: >
             pushd {project} &&
@@ -107,6 +108,16 @@ jobs:
           pip install twine &&
           twine upload wheelhouse/*
 
+  # pitfall for Windows, while this works for linux and macos:
+  # run: |
+  #    command1
+  #    command2
+  # it will not work for windows! Only command1 is executed; hence this syntax is
+  # replaced with:
+  # run: >
+  #     command1 &&
+  #     command2
+
   deploy_windows_cibuildwheel:
     name: CIBW deploy ${{ matrix.cibw_python }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}