merged master

jupyterhub · Sep 15, 2021 · 61ce7c5 · 61ce7c5
2 parents 387ead8 + 634f2be
commit 61ce7c5
Show file tree

Hide file tree

Showing 26 changed files with 761 additions and 395 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -34,9 +34,9 @@ workflows:
       - build_docs
       - push_docs:
           filters:  # using regex filters requires the entire branch to match
-              branches:
-                only:  # only branches matching the below regex filters will run
-                  - master
+            branches:
+              only:  # only branches matching the below regex filters will run
+                - main
 
 commands:
   build_site:
@@ -62,4 +62,4 @@ commands:
           name: Build docs to store
           command: |
             cd docs
-            make html
+            make html
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,12 @@
+[flake8]
+# Ignore style and complexity
+# E: style errors
+# W: style warnings
+# C: complexity
+# E402: module level import not at top of file
+# I100: Import statements are in the wrong order
+# I101: Imported names are in the wrong order. Should be
+ignore = E, C, W, E402, I100, I101, D400
+exclude =
+    .cache,
+    .github
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -6,17 +6,7 @@ name: Tests
 on:
   pull_request:
   push:
-
-defaults:
-  run:
-    # Declare bash be used by default in this workflow's "run" steps.
-    #
-    # NOTE: bash will by default run with:
-    #   --noprofile: Ignore ~/.profile etc.
-    #   --norc:      Ignore ~/.bashrc etc.
-    #   -e:          Exit directly on errors
-    #   -o pipefail: Don't mask errors from a command piped into another command
-    shell: bash
+  workflow_dispatch:
 
 jobs:
   test:
@@ -27,23 +17,38 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      - name: Run webpack to build static assets
+        run: |
+            npm install
+            npm run webpack
+
       - name: Install Python
         uses: actions/setup-python@v2
         with:
           python-version: '3.8'
 
-      # preserve pip cache to speed up installation
-      - name: Cache pip
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          # Look to see if there is a cache hit for the corresponding requirements file
-          key: ${{ runner.os }}-pip-${{ hashFiles('*requirements.txt') }}
-          restore-keys: |
-            ${{ runner.os }}-pip-
-
-      - name: Install
-        run: pip install tox
+      # DISABLED: Since we don't pin our dependencies in dev-requirements.txt
+      #           and only refresh the cache when it changes, we end up with a
+      #           cache that remains for too long and cause failures. Due to
+      #           this, it has been disabled.
+      #
+      # - name: Cache pip dependencies
+      #   uses: actions/cache@v2
+      #   with:
+      #     path: ~/.cache/pip
+      #     # Look to see if there is a cache hit for the corresponding requirements file
+      #     key: ${{ runner.os }}-pip-${{ hashFiles('*requirements.txt') }}
+      #     restore-keys: |
+      #       ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          pip install -r dev-requirements.txt
+
+      - name: Run flake8 linter
+        run: flake8
 
       - name: Run tests
-        run: tox
+        run: |
+          pip install .
+          pytest --verbose --maxfail=2 --color=yes --cov nbgitpuller
diff --git a/.gitignore b/.gitignore
@@ -16,4 +16,9 @@ test-repo/
 venv/
 
 .ipynb_checkpoints
-docs/_build
+docs/_build
+
+node_modules/
+package-lock.json
+
+nbgitpuller/static/dist
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,84 @@
+## 1.0
+
+### 1.0.2 - 2021-09-03
+
+A release to fix an issue that stopped us from publishing nbgitpuller on
+conda-forge.
+
+#### Maintenance and upkeep improvements
+
+- Fix jupyter-packaging reference, use - instead of _ [#219](https://github.com/jupyterhub/nbgitpuller/pull/219) ([@consideRatio](https://github.com/consideRatio))
+
+### 1.0.1 - 2021-09-02
+
+This release fixes a failure to install from a source distribution of the
+package without having `node` and `npm` installed.
+
+#### Maintenance and upkeep improvements
+
+- Remove six from dev-requirements.txt [#213](https://github.com/jupyterhub/nbgitpuller/pull/213) ([@consideRatio](https://github.com/consideRatio))
+- Slim package.json to avoid fields relevant to npm publication [#212](https://github.com/jupyterhub/nbgitpuller/pull/212) ([@consideRatio](https://github.com/consideRatio))
+- Use jupyter-packaging for npm build [#211](https://github.com/jupyterhub/nbgitpuller/pull/211) ([@manics](https://github.com/manics))
+
+#### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterhub/nbgitpuller/graphs/contributors?from=2021-09-01&to=2021-09-02&type=c))
+
+[@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3AconsideRatio+updated%3A2021-09-01..2021-09-02&type=Issues) | [@manics](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Amanics+updated%3A2021-09-01..2021-09-02&type=Issues)
+
+### 1.0.0 - 2021-09-01
+
+This is not a breaking release, we have just decided to let this be 1.0.0 to
+better communicate changes via the version number in future releases.
+
+#### Enhancements made
+
+- Support use with jupyter_server by decoupling notebook dependencies [#193](https://github.com/jupyterhub/nbgitpuller/pull/193) ([@GeorgianaElena](https://github.com/GeorgianaElena))
+
+#### Bugs fixed
+
+- Use addon instead of term when calling fit and import xterm css [#197](https://github.com/jupyterhub/nbgitpuller/pull/197) ([@GeorgianaElena](https://github.com/GeorgianaElena))
+
+#### Maintenance and upkeep improvements
+
+- Rename nbgitpuller repo's master branch to main [#189](https://github.com/jupyterhub/nbgitpuller/pull/189) ([@consideRatio](https://github.com/consideRatio))
+
+#### Documentation improvements
+
+- Update contributing guide to use `git-pull` [#202](https://github.com/jupyterhub/nbgitpuller/pull/202) ([@fperez](https://github.com/fperez))
+
+#### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterhub/nbgitpuller/graphs/contributors?from=2021-06-24&to=2021-08-31&type=c))
+
+[@choldgraf](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Acholdgraf+updated%3A2021-06-24..2021-08-31&type=Issues) | [@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3AconsideRatio+updated%3A2021-06-24..2021-08-31&type=Issues) | [@fmaussion](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Afmaussion+updated%3A2021-06-24..2021-08-31&type=Issues) | [@fperez](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Afperez+updated%3A2021-06-24..2021-08-31&type=Issues) | [@GeorgianaElena](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3AGeorgianaElena+updated%3A2021-06-24..2021-08-31&type=Issues) | [@manics](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Amanics+updated%3A2021-06-24..2021-08-31&type=Issues) | [@nibheis](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Anibheis+updated%3A2021-06-24..2021-08-31&type=Issues) | [@TimoRoth](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3ATimoRoth+updated%3A2021-06-24..2021-08-31&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Awelcome+updated%3A2021-06-24..2021-08-31&type=Issues) | [@yuvipanda](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Ayuvipanda+updated%3A2021-06-24..2021-08-31&type=Issues)
+
 ## 0.10
 
+### 0.10.2 - 2021-08-25
+
+This is a critical security release, please upgrade to this and see [GHSA-mq5p-2mcr-m52j](https://github.com/jupyterhub/nbgitpuller/security/advisories/GHSA-mq5p-2mcr-m52j) more information.
+
+### 0.10.1 - 2021-06-24
+
+#### Bugs fixed
+
+- Added branch name back to command-line usage [#185](https://github.com/jupyterhub/nbgitpuller/pull/185) ([@sean-morris](https://github.com/sean-morris))
+
+#### Documentation improvements
+
+- Provide cleaner feedback for lint vs test failures [#181](https://github.com/jupyterhub/nbgitpuller/pull/181) ([@yuvipanda](https://github.com/yuvipanda))
+
+#### Continuous integration
+
+- Fix CI failures by disabling pip cache [#188](https://github.com/jupyterhub/nbgitpuller/pull/188) ([@consideRatio](https://github.com/consideRatio))
+
+#### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterhub/nbgitpuller/graphs/contributors?from=2021-06-09&to=2021-06-24&type=c))
+
+[@consideRatio](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3AconsideRatio+updated%3A2021-06-09..2021-06-24&type=Issues) | [@manics](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Amanics+updated%3A2021-06-09..2021-06-24&type=Issues) | [@sean-morris](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Asean-morris+updated%3A2021-06-09..2021-06-24&type=Issues) | [@yuvipanda](https://github.com/search?q=repo%3Ajupyterhub%2Fnbgitpuller+involves%3Ayuvipanda+updated%3A2021-06-09..2021-06-24&type=Issues)
+
 ### 0.10.0 - 2021-06-09
 
 #### Enhancements made

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,5 +1,6 @@
 include *.md
 include LICENSE
+include package.json
 include setup.cfg
 recursive-include nbgitpuller/static *
 recursive-include nbgitpuller/templates *
diff --git a/README.md b/README.md
@@ -1,5 +1,6 @@
 # [nbgitpuller](https://github.com/jupyterhub/nbgitpuller)
 
+
 [![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/nbgitpuller/Tests?logo=github&label=tests)](https://github.com/jupyterhub/nbgitpuller/actions)
 [![CircleCI build status](https://img.shields.io/circleci/build/github/jupyterhub/nbgitpuller?logo=circleci&label=docs)](https://circleci.com/gh/jupyterhub/nbgitpuller)
 [![](https://img.shields.io/pypi/v/nbgitpuller.svg?logo=pypi)](https://pypi.python.org/pypi/nbgitpuller)

diff --git a/RELEASE.md b/RELEASE.md
@@ -9,13 +9,13 @@ The PyPI release is done automatically by TravisCI when a tag is pushed.
 
 ## Steps to make a release
 
-1. Checkout master and make sure it is up to date.
+1. Checkout main and make sure it is up to date.
 
    ```shell
    ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
-   git checkout master
-   git fetch $ORIGIN master
-   git reset --hard $ORIGIN/master
+   git checkout main
+   git fetch $ORIGIN main
+   git reset --hard $ORIGIN/main
    # WARNING! This next command deletes any untracked files in the repo
    git clean -xfd
    ```
@@ -24,7 +24,7 @@ The PyPI release is done automatically by TravisCI when a tag is pushed.
    [`nbgitpuller/version.py`](nbgitpuller/version.py)
    and make a commit.
 
-   ```
+   ```shell
    git add nbgitpuller/version.py
    VERSION=...  # e.g. 1.2.3
    git commit -m "release $VERSION"
@@ -33,20 +33,21 @@ The PyPI release is done automatically by TravisCI when a tag is pushed.
 1. Reset the `__version__` variable in
    [`nbgitpuller/version.py`](nbgitpuller/version.py)
    to an incremented patch version with a `dev` element, then make a commit.
-   ```
+
+   ```shell
    git add nbgitpuller/version.py
    git commit -m "back to dev"
    ```
 
-1. Push your two commits to master.
+1. Push your two commits to main.
 
    ```shell
    # first push commits without a tags to ensure the
    # commits comes through, because a tag can otherwise
    # be pushed all alone without company of rejected
    # commits, and we want have our tagged release coupled
-   # with a specific commit in master
-   git push $ORIGIN master
+   # with a specific commit in main
+   git push $ORIGIN main
    ```
 
 1. Create a git tag for the pushed release commit and push it.

diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -0,0 +1,5 @@
+jupyter-packaging>=0.10
+pytest
+pytest-cov
+flake8
+nbclassic
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,9 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-import os
-import requests
-
 github_doc_root = "https://github.com/rtfd/recommonmark/tree/master/doc/"
 
 
@@ -35,8 +32,8 @@ def setup(app):
 source_suffix = [".rst", ".md"]
 
 
-# The master toctree document.
-master_doc = "index"
+# The root toctree document.
+root_doc = master_doc = "index"
 
 # General information about the project.
 project = "nbgitpuller"
@@ -88,7 +85,7 @@ def setup(app):
 html_context = {
     "github_user": "jupyterhub",
     "github_repo": "nbgitpuller",
-    "github_version": "master",
+    "github_version": "main",
     "doc_path": "doc",
     "source_suffix": source_suffix,
 }
@@ -133,7 +130,7 @@ def setup(app):
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (
-        master_doc,
+        root_doc,
         "nbgitpuller.tex",
         "nbgitpuller Documentation",
         "The nbgitpuller Team",
@@ -146,7 +143,7 @@ def setup(app):
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "nbgitpuller", "nbgitpuller Documentation", [author], 1)]
+man_pages = [(root_doc, "nbgitpuller", "nbgitpuller Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output -------------------------------------------
@@ -156,7 +153,7 @@ def setup(app):
 #  dir menu entry, description, category)
 texinfo_documents = [
     (
-        master_doc,
+        root_doc,
         "nbgitpuller",
         "nbgitpuller Documentation",
         author,