Postmortem for 0.2.0a0 (#58)

deathbeds · Oct 27, 2023 · cb67d32 · cb67d32
1 parent ac37c3c
commit cb67d32
Show file tree

Hide file tree

Showing 24 changed files with 257 additions and 144 deletions.
diff --git a/.binder/environment.yml b/.binder/environment.yml
@@ -4,8 +4,6 @@ channels:
   - conda-forge
   - nodefaults
   - conda-forge/label/jupyterlab_fonts_alpha
-  - conda-forge/label/jupyterlite_core_rc
-  - conda-forge/label/jupyterlite_pyodide_kernel_alpha
 
 dependencies:
   - python >=3.11,<3.12
@@ -42,7 +40,7 @@ dependencies:
   - docutils >=0.18
   - mdit-py-plugins <0.4.0
   - myst-nb
-  - pydata-sphinx-theme
+  - pydata-sphinx-theme ==0.14.2
   - sphinx >=5.1,<6
   - sphinx-autobuild
   - sphinx-copybutton
@@ -52,8 +50,8 @@ dependencies:
   - pytest-check-links
   # lite
   - python-libarchive-c
-  - jupyterlite-core ==0.2.0rc1
-  - jupyterlite-pyodide-kernel ==0.2.0a2
+  - jupyterlite-core ==0.2.0
+  - jupyterlite-pyodide-kernel ==0.2.0
   ### environment-docs.yml ###
   ### environment-test.yml ###
   # test

diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md
@@ -4,29 +4,52 @@ about: Prepare for a release
 labels: maintenance
 ---
 
-- [ ] merge all outstanding PRs
-- [ ] ensure the versions have been bumped (check with `doit`)
-- [ ] ensure the CHANGELOG is up-to-date
-  - [ ] move the new release to the top of the stack
-- [ ] validate on binder
+- [ ] merge all outstanding PRs [![ms-badge]](ms)
+    <!-- change `1234`` to the milestone id (small number) and `1.2.3.4` to the label -->
+  [ms-badge]:
+    https://img.shields.io/github/milestones/progress/deathbeds/jupyterlab-deck/1234
+    <!-- change  `1.2.3.4` to the label -->
+  [ms]:
+    https://github.com/deathbeds/jupyterlab-deck/issues?q=is%3Aopen+is%3Aissue+milestone%3A1.2.3.4
+  - [ ] _blocking #PR here_
+- [ ] ensure `CHANGELOG.md` is up-to-date
+- [ ] ensure the versions have been bumped
 - [ ] validate on ReadTheDocs
-- [ ] wait for a successful build of `main`
-- [ ] download the `dist` archive and unpack somewhere (maybe a fresh `dist`)
+  - [ ] _URL of build_
+- [ ] wait for a successful build of `dev`
+  - [ ] _URL of build_
+- [ ] download the `dist` archive and unpack somewhere
 - [ ] create a new release through the GitHub UI
-  - [ ] paste in the relevant CHANGELOG entries
+  - [ ] paste in the relevant `CHANGELOG.md` entries
   - [ ] upload the artifacts
-- [ ] actually upload to npm.com, pypi.org
-  ```bash
-  cd dist
-  twine upload *.tar.gz *.whl
-  npm login
-  npm publish deathbeds-jupyterlab-deck-$VERSION.tgz
-  npm logout
-  ```
+  - [ ] upload distribution to package repositories
+    ```bash
+    #!/usr/bin/env bash
+    set -eux
+    ls jupyterlab_deck.*.tar.gz jupyterlab_deck.*.whl deathbeds-jupyterlab-deck*.tgz
+    twine upload jupyterlab_deck.*.tar.gz jupyterlab_deck.*.whl
+    npm login
+    for tarball in deathbeds-jupyterlab-deck*.tgz; do
+      npm publish $tarball
+    done
+    npm logout
+    ```
+    - [ ] _URL on npmjs.org here_
+    - [ ] _URL on pypi here_
 - [ ] postmortem
-  - [ ] handle `conda-forge` feedstock tasks
-  - [ ] validate on binder via simplest-possible gists
-  - [ ] bump to next development version
-  - [ ] bump the `CACHE_EPOCH`
-  - [ ] rebuild `yarn.lock`
-  - [ ] update release procedures with lessons learned
+  - [ ] handle `conda-forge` [feedstock] tasks
+    - [ ] _URL on `conda-forge/jupyterlab-deck-feedstock` here_
+    - [ ] _URL on `anaconda.org`_
+  - [ ] validate on binder via simplest-possible gists (if viable)
+  - [ ] create postmortem PR _PR# here_
+    - [ ] bump to next development version
+    - [ ] bump the `CACHE_EPOCH`
+    - [ ] rebuild nodejs locks
+      - [ ] `rm yarn.lock`
+      - [ ] `doit lint || doit lint`
+    - [ ] commit the new locks
+    - [ ] update release procedures with lessons learned in
+          `.github/ISSUE_TEMPLATE/release.md`
+
+[feedstock]: https://github.com/conda-forge/jupyterlab-deck-feedstock
+[release]: https://github.com/deathbeds/jupyterlab-deck/releases
diff --git a/.github/environment-build.yml b/.github/environment-build.yml
@@ -4,8 +4,6 @@ channels:
   - conda-forge
   - nodefaults
   - conda-forge/label/jupyterlab_fonts_alpha
-  - conda-forge/label/jupyterlite_core_rc
-  - conda-forge/label/jupyterlite_pyodide_kernel_alpha
 
 dependencies:
   - python >=3.10,<3.13

diff --git a/.github/environment-docs.yml b/.github/environment-docs.yml
@@ -4,8 +4,6 @@ channels:
   - conda-forge
   - nodefaults
   - conda-forge/label/jupyterlab_fonts_alpha
-  - conda-forge/label/jupyterlite_core_rc
-  - conda-forge/label/jupyterlite_pyodide_kernel_alpha
 
 dependencies:
   - python >=3.10,<3.13
@@ -33,7 +31,7 @@ dependencies:
   - docutils >=0.18
   - mdit-py-plugins <0.4.0
   - myst-nb
-  - pydata-sphinx-theme
+  - pydata-sphinx-theme ==0.14.2
   - sphinx >=5.1,<6
   - sphinx-autobuild
   - sphinx-copybutton
@@ -43,6 +41,6 @@ dependencies:
   - pytest-check-links
   # lite
   - python-libarchive-c
-  - jupyterlite-core ==0.2.0rc1
-  - jupyterlite-pyodide-kernel ==0.2.0a2
+  - jupyterlite-core ==0.2.0
+  - jupyterlite-pyodide-kernel ==0.2.0
   ### environment-docs.yml ###
diff --git a/.github/environment-lint.yml b/.github/environment-lint.yml
@@ -4,8 +4,6 @@ channels:
   - conda-forge
   - nodefaults
   - conda-forge/label/jupyterlab_fonts_alpha
-  - conda-forge/label/jupyterlite_core_rc
-  - conda-forge/label/jupyterlite_pyodide_kernel_alpha
 
 dependencies:
   - python >=3.10,<3.13

diff --git a/.github/environment-test-lab35.yml b/.github/environment-test-lab35.yml
@@ -4,8 +4,6 @@ channels:
   - conda-forge
   - nodefaults
   - conda-forge/label/jupyterlab_fonts_alpha
-  - conda-forge/label/jupyterlite_core_rc
-  - conda-forge/label/jupyterlite_pyodide_kernel_alpha
 
 dependencies:
   # a more precise python pin is added in CI

diff --git a/.github/environment-test.yml b/.github/environment-test.yml
@@ -4,8 +4,6 @@ channels:
   - conda-forge
   - nodefaults
   - conda-forge/label/jupyterlab_fonts_alpha
-  - conda-forge/label/jupyterlite_core_rc
-  - conda-forge/label/jupyterlite_pyodide_kernel_alpha
 
 dependencies:
   # a more precise python pin is added in CI

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,31 @@
+<!--
+Thanks for contributing to jupyterlab-deck!
+Please fill out the following items to submit a pull request.
+
+See the contributing guidelines for more information:
+https://github.com/deathbeds/jupyterlab-deck/main/CONTRIBUTING.md
+-->
+
+## Checklist
+
+- [ ] ran `doit lint` locally
+
+## References
+
+<!-- Note issue numbers this pull request addresses (should be at least one, see contributing guidelines above). -->
+
+<!-- Note any other pull requests that address this issue and how this pull request is different. -->
+
+## Code changes
+
+<!-- Describe the code changes and how they address the issue. -->
+
+## User-facing changes
+
+<!-- Describe any visual or user interaction changes and how they address the issue. -->
+
+<!-- For visual changes, include before and after screenshots here. -->
+
+## Backwards-incompatible changes
+
+<!-- Describe any backwards-incompatible changes to jupyterlab-deck public APIs. -->
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,7 +16,7 @@ env:
 
   # our stuff
   ROBOT_RETRIES: '3'
-  CACHE_EPOCH: '4'
+  CACHE_EPOCH: '5'
   DOIT_N_BUILD: '-n4'
   PABOT_PROCESSES: '3'
 
@@ -169,6 +169,9 @@ jobs:
       - name: test legacy
         run: doit legacy:robot
 
+      - name: report
+        run: doit report
+
       - name: docs
         run: doit docs
 

diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -15,7 +15,7 @@ env:
 
   # our stuff
   ROBOT_RETRIES: '3'
-  CACHE_EPOCH: '4'
+  CACHE_EPOCH: '5'
   PABOT_PROCESSES: '3'
 
 jobs:
@@ -70,6 +70,15 @@ jobs:
       - name: test latest (robot with cov)
         run: doit test:robot
 
+      - name: test legacy (pytest)
+        run: doit legacy:pytest
+
+      - name: test legacy (robot with cov)
+        run: doit legacy:robot
+
+      - name: rport
+        run: doit report
+
       - name: site
         run: doit site
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 ## Changelog
 
+### `0.2.0a1`
+
+- [#56] addresses style and behavior differences on Notebook 7 and JupyterLab 4
+
+[#56]: https://github.com/deathbeds/jupyterlab-deck/issues/56
+
 ### `0.2.0a0`
 
 - [#36] adds support for Jupyter Notebook 7 and JupyterLab 4

diff --git a/atest/resources/Coverage.resource b/atest/resources/Coverage.resource
@@ -21,7 +21,7 @@ Capture Page Coverage
     ${cov_json} =    Execute Javascript
     ...    return window.__coverage__ && JSON.stringify(window.__coverage__, null, 2)
     IF    ${cov_json}
-        Create File    ${ROBOCOV}${/}${name}.json    ${cov_json}
+        Create File    ${OUTPUT_DIR}${/}__coverage__${/}${name}.cov.json    ${cov_json}
     END
 
 Reset JupyterLab And Close With Coverage

diff --git a/atest/resources/Fixtures.resource b/atest/resources/Fixtures.resource
@@ -8,15 +8,17 @@ Resource            ./Coverage.resource
 
 *** Variables ***
 ${ROOT_EXAMPLES}    ${ROOT}${/}examples
-${README_IPYNB}     README.ipynb
-${README_MD}        README.md
+${LOGO_SVG}         deck.svg
 ${HISTORY_IPYNB}    History.ipynb
 ${LAYERS_IPYNB}     Layers.ipynb
+${README_IPYNB}     README.ipynb
+${README_MD}        README.md
 @{ALL_EXAMPLES}
-...                 ${ROOT_EXAMPLES}${/}${README_IPYNB}
+...                 ${ROOT_EXAMPLES}${/}${LOGO_SVG}
 ...                 ${ROOT_EXAMPLES}${/}${HISTORY_IPYNB}
-...                 ${ROOT_EXAMPLES}${/}${README_MD}
 ...                 ${ROOT_EXAMPLES}${/}${LAYERS_IPYNB}
+...                 ${ROOT_EXAMPLES}${/}${README_IPYNB}
+...                 ${ROOT_EXAMPLES}${/}${README_MD}
 
 
 *** Keywords ***

diff --git a/docs/_static/theme.css b/docs/_static/theme.css
@@ -1,3 +1,7 @@
 iframe {
   box-shadow: 2px 2px 5px var(--pst-color-text-muted);
 }
+
+.table {
+  --bs-table-bg: transparent;
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -86,6 +86,8 @@
             "icon": "fa-brands fa-npm",
         },
     ],
+    # rely on browser-native accessibility features instead of custom JS
+    "navigation_with_keys": False,
 }
 
 html_context = {

diff --git a/docs/dictionary.txt b/docs/dictionary.txt
@@ -1,6 +1,3 @@
-0a0
-0b0
-0rc0
 Changelog
 ci
 composable