Merge pull request #3 from jupyterlab/releaser

Add `check-release` workflow on CI

Author: jtpio

.github/workflows/check-release.yml

@@ -0,0 +1,41 @@
+name: Check Release
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - "*"
+
+permissions:
+  contents:
+    write
+
+jobs:
+  check_release:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        group: [check_release, link_check]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Base Setup
+        uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
+
+      - name: Install Dependencies
+        run: |
+          pip install -e .
+
+      - name: Check Release
+        if: ${{ matrix.group == 'check_release' }}
+        env:
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_TOKEN }}
+        uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Check Links
+        if: ${{ matrix.group == 'link_check' }}
+        uses: jupyter-server/jupyter_releaser/.github/actions/check-links@v1

.github/workflows/enforce-label.yml

@@ -0,0 +1,11 @@
+name: Enforce PR label
+
+on:
+  pull_request:
+    types: [labeled, unlabeled, opened, edited, synchronize]
+jobs:
+  enforce-label:
+    runs-on: ubuntu-latest
+    steps:
+      - name: enforce-triage-label
+        uses: jupyterlab/maintainer-tools/.github/actions/enforce-label@v1

README.md

@@ -5,26 +5,30 @@ This project provides a way for JupyterLab and other frontends to switch to [Jup
 ## Basic Usage
 
 Install from PyPI:
+
 ```
-> pip install notebook_shim
+pip install notebook_shim
 ```
+
 This will automatically enable the extension in Jupyter Server.
 
 ## Usage
 
 This project also includes an API for shimming traits that moved from `NotebookApp` in to `ServerApp` in Jupyter Server. This can be used by applications that subclassed `NotebookApp` to leverage the Python server backend of Jupyter Notebooks. Such extensions should *now* switch to `ExtensionApp` API in Jupyter Server and add `NotebookConfigShimMixin` in their inheritance list to properly handle moved traits.
 
 For example, an application class that previously looked like:
+
 ```python
 from notebook.notebookapp import NotebookApp
 
 class MyApplication(NotebookApp):
 ```
+
 should switch to look something like:
+
 ```python
 from jupyter_server.extension.application import ExtensionApp
 from notebook_shim.shim import NotebookConfigShimMixin
 
 class MyApplication(NotebookConfigShimMixin, ExtensionApp):
-```
-
+```

RELEASE.md

@@ -1,15 +1,5 @@
-To create a release, update the version number in `noetbook_shim/__version__.py`, then run the following:
+# Making a Release of `notebook_shim`
 
-```
-git clean -dffx
-python setup.py sdist
-python setup.py bdist_wheel
-export script_version=`python setup.py --version 2>/dev/null`
-git commit -a -m "Release $script_version"
-git tag $script_version
-git push --all
-git push --tags
-pip install twine
-twine check dist/*
-twine upload dist/*
-```
+## Using `jupyter_releaser`
+
+The recommended way to make a release is to use [`jupyter_releaser`](https://github.com/jupyter-server/jupyter_releaser#checklist-for-adoption).

pyproject.toml

@@ -15,7 +15,7 @@ testpaths = [
 skip = ["check-links"]
 
 [tool.tbump.version]
-current = "0.4.0.dev0"
+current = "0.1.0"
 regex = '''
   (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)
   ((?P<channel>a|b|rc|.dev)(?P<release>\d+))?

setup.cfg

@@ -1,13 +1,13 @@
 [metadata]
 name = notebook_shim
 version = attr: notebook_shim._version.__version__
-description = Jupyter Notebook as a Jupyter Server extension.
+description = A shim layer for notebook traits and config
 long_description = file: README.md
 long_description_content_type = text/markdown
 license_file = LICENSE
 author = Jupyter Development Team
 author_email = [email protected]
-url = https://jupyter.org
+url = https://github.com/jupyterlab/notebook_shim
 platforms = Linux, Mac OS X, Windows
 keywords = ipython, jupyter
 classifiers =
@@ -16,16 +16,16 @@ classifiers =
     Intended Audience :: Science/Research
     License :: OSI Approved :: BSD License
     Programming Language :: Python
-    Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
+    Programming Language :: Python :: 3.10
 
 [options]
 zip_safe = False
 include_package_data = True
 packages = find:
-python_requires = >=3.6
+python_requires = >=3.7
 install_requires =
     jupyter_server~=1.8