🧪 TESTS: Move to GitHub Actions for CI

Author: chrisjsewell

.github/workflows/tests.yml

@@ -0,0 +1,83 @@
+name: continuous-integration
+
+on: [push, pull_request]
+
+jobs:
+  pre-commit:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[cli,code_style]
+    - name: Run pre-commit
+      run: |
+        pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
+
+
+  tests:
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.6, 3.7, 3.8]
+        include:
+          - os: windows-latest
+            python-version: 3.7
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[cli,testing]
+    - name: Run pytest
+      run: |
+        pytest --durations=10 --cov=jupyter_cache --cov-report=xml --cov-report=term-missing
+        coverage xml
+      # for some reason the tests/conftest.py::check_nbs fixture breaks pytest-cov's cov-report outputting
+      # this is why we run `coverage xml` afterwards (required by codecov)
+    - name: Upload to Codecov
+      if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.7 && github.repository == 'executablebooks/jupyter-cache'
+      uses: codecov/codecov-action@v1
+      with:
+        name: jupyter-cache-pytests-py3.7
+        flags: pytests
+        file: ./coverage.xml
+        fail_ci_if_error: true
+
+  publish:
+
+    name: Publish to PyPi
+    needs: [pre-commit, tests]
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v2
+      - name: Set up Python 3.7
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+      - name: Build package
+        run: |
+          pip install wheel
+          python setup.py sdist bdist_wheel
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@v1.1.0
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_KEY }}

.readthedocs.yml

@@ -7,3 +7,7 @@ python:
         path: .
         extra_requirements:
           - rtd
+
+sphinx:
+  builder: html
+  fail_on_warning: true

.travis.yml

@@ -157,7 +157,14 @@ def execute(self, input_iterator, timeout=30):
                                 and "timeout" in nb_bundle.nb.metadata.execution
                             ):
                                 timeout = nb_bundle.nb.metadata.execution.timeout
-                            executenb(nb_bundle.nb, cwd=tmpdirname, timeout=timeout)
+                            # TODO: for now we don't use the new record_timing feature
+                            # because it can affect test results
+                            executenb(
+                                nb_bundle.nb,
+                                cwd=tmpdirname,
+                                timeout=timeout,
+                                record_timing=False,
+                            )
                     except Exception:
                         exc_string = "".join(traceback.format_exc())
                         self.logger.error("Execution Failed: {}".format(uri))

jupyter_cache/executors/basic.py

@@ -11,19 +11,21 @@
     },
     {
       "cell_type": "code",
-      "execution_count": 1,
+      "execution_count": 2,
       "metadata": {},
       "source": [
-        "with open('artifact.txt', 'w',encoding=\"utf-8\") as handle:"
+        "with open('artifact.txt', 'w', encoding='utf-8') as handle:\n",
+        "    handle.write('hi')"
       ],
-      "outputs": []
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {},
-      "outputs": [],
-      "source": []
+      "outputs": [
+        {
+          "name": "stdout",
+          "output_type": "stream",
+          "text": [
+            "1\n"
+          ]
+        }
+      ]
     }
   ],
   "metadata": {