Merge pull request #7 from itepifanio/clean-nb

Clean nb
itepifanio · Apr 7, 2023 · 017b20c · 017b20c
2 parents a83ff73 + cbd8fd5
commit 017b20c
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 39 deletions.
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -21,6 +21,10 @@ jobs:
       run: |
         pip install -e .[dev]
 
+    - name: Check nbs are clean
+      run: ./scripts/check_nbs_clean.sh
+      shell: bash
+
     - name: Run flake8
       run: nbqa flake8 nbs/*.ipynb
 

diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -1,8 +1,8 @@
 name: Publish package to TestPypi
 
 on:
-  push:
-    branches: ["main"]
+  release:
+    types: [published]
 jobs:
   publish:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -1,4 +1,4 @@
-name: CI
+name: Tests
 on:  [workflow_dispatch, pull_request, push]
 
 jobs:

diff --git a/nbs/06_hand.ipynb b/nbs/06_hand.ipynb
@@ -137,18 +137,7 @@
    "execution_count": null,
    "id": "8cabce32",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "Card(rank=1, suit='spades')"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| exec_doc\n",
     "#| code-fold: false\n",
@@ -171,18 +160,7 @@
    "execution_count": null,
    "id": "45aa3d73",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[Card(rank=1, suit='spades')]"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| exec_doc\n",
     "[card for card in hand]"
@@ -193,18 +171,7 @@
    "execution_count": null,
    "id": "1b8584bd",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "0"
-      ]
-     },
-     "execution_count": null,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "#| exec_doc\n",
     "hand.discard()  # type: ignore\n",

diff --git a/scripts/check_nbs_clean.sh b/scripts/check_nbs_clean.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+#set -x
+
+nbdev_clean --clear_all
+
+GIT_STATUS_FAILED(){
+  git status -uno -s |grep '.*\.ipynb'
+}
+
+if GIT_STATUS_FAILED; then
+  echo "!! ::error:: Detected notebooks that are not cleaned."
+  false;
+fi