Merge pull request #6304 from blink1073/update-ci

Clean up CI

.github/workflows/build.yml

@@ -2,16 +2,17 @@ name: Build
 
 on:
   push:
-    branches:
-      - '*'
+    branches: ['main']
   pull_request:
-    branches:
-      - '*'
 
 permissions:
   contents:
     write
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
 env:
   PIP_DISABLE_PIP_VERSION_CHECK: 1
 

.github/workflows/buildutils.yml

@@ -2,14 +2,17 @@ name: Build Utilities
 
 on:
   push:
-    branches: '*'
+    branches: ['main']
   pull_request:
-    branches: '*'
 
 defaults:
   run:
     shell: bash -l {0}
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
 jobs:
   versioning:
     runs-on: ubuntu-latest

.github/workflows/check-release.yml

@@ -1,36 +1,38 @@
 name: Check Release
 on:
   push:
-    branches:
-      - "*"
+    branches: ["main"]
   pull_request:
-    branches:
-      - "*"
 
 permissions:
   contents:
     write
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
 jobs:
   check_release:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        group: [check_release, link_check]
+      fail-fast: false
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-
       - name: Base Setup
         uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
-
-      - name: Upgrade packaging dependencies
-        run: |
-          pip install --upgrade jupyter-packaging~=0.10 --user
-
       - name: Install Dependencies
         run: |
-          pip install .
-
+          pip install -e .
       - name: Check Release
+        if: ${{ matrix.group == 'check_release' }}
         uses: jupyter-server/jupyter_releaser/.github/actions/check-release@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           version_spec: next
+      - name: Check Links
+        if: ${{ matrix.group == 'link_check' }}
+        uses: jupyter-server/jupyter_releaser/.github/actions/check-links@v1

.github/workflows/docs.yml

@@ -1,40 +1,23 @@
 name: Docs Tests
 on:
   push:
-    branches: '*'
+    branches: ['main']
   pull_request:
-    branches: '*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
 jobs:
   build:
-    runs-on: ${{ matrix.os }}-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu]
-        python-version: [ '3.7' ]
+    runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v1
-    - name: Install Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/checkout@v2
+    - name: Base Setup
+      uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
       with:
-        python-version: ${{ matrix.python-version }}
-        architecture: 'x64'
-    - name: Upgrade packaging dependencies
-      run: |
-        pip install --upgrade pip setuptools wheel
-    - name: Get pip cache dir
-      id: pip-cache
-      run: |
-        echo "::set-output name=dir::$(pip cache dir)"
-    - name: Cache pip
-      uses: actions/cache@v1
-      with:
-        path: ${{ steps.pip-cache.outputs.dir }}
-        key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('setup.py') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-${{ matrix.python-version }}-
-          ${{ runner.os }}-pip-
+        python_version: '3.7'
     - name: Install the Python dependencies
       run: |
         pip install -e .[test] codecov
@@ -47,6 +30,6 @@ jobs:
     - name: Run tests on documentation
       run: |
         EXIT_STATUS=0
-        make -C docs/ html || EXIT_STATUS=$?
+        make -C docs/ html SPHINXOPTS="-W" || EXIT_STATUS=$?
         pytest --nbval --current-env docs || EXIT_STATUS=$?
         exit $EXIT_STATUS

.github/workflows/ui-tests.yml

@@ -1,6 +1,13 @@
 name: UI Tests
 
-on: [push, pull_request]
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
 
 jobs:
   build:
@@ -97,4 +104,4 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: notebook-${{ matrix.browser }}-updated-snapshots
-          path: ui-tests/test
+          path: ui-tests/test

.gitignore

@@ -117,6 +117,8 @@ notebook/static/*
 !notebook/static/favicons
 notebook/labextension
 notebook/schemas
+docs/source/changelog.md
+docs/source/contributing.md
 
 # playwright
 ui-tests/test-results

CHANGELOG.md

@@ -151,7 +151,7 @@ Use `pip install pip --upgrade` to upgrade pip. Check pip version with
 - Add missing file to manifest [#6122](https://github.com/jupyter/notebook/pull/6122) ([@afshin](https://github.com/afshin))
 - Fix issue #3218 [#6108](https://github.com/jupyter/notebook/pull/6108) ([@Nazeeh21](https://github.com/Nazeeh21))
 - Fix version of jupyter-packaging in pyproject.toml [#6101](https://github.com/jupyter/notebook/pull/6101) ([@frenzymadness](https://github.com/frenzymadness))
-- "#element".tooltip is not a function on home page fixed. [#6070](https://github.com/jupyter/notebook/pull/6070) ([@ilayh123](https://github.com/ilayh123))
+- "#element".tooltip is not a function on home page fixed. [#6070](https://github.com/jupyter/notebook/pull/6070) @ilayh123
 
 ### Maintenance and upkeep improvements
 
@@ -1014,7 +1014,7 @@ Thanks to the following contributors:
 - Peter Parente ([parente](https://github.com/parente))
 - Paul Masson ([paulmasson](https://github.com/paulmasson))
 - Philipp Rudiger ([philippjfr](https://github.com/philippjfr))
-- Mac Knight ([Shels1909](https://github.com/Shels1909))
+- Mac Knight (Shels1909)
 - Hisham Elsheshtawy ([Sheshtawy](https://github.com/Sheshtawy))
 - Simon Biggs ([SimonBiggs](https://github.com/SimonBiggs))
 - Sunil Hari (`@sunilhari`)
@@ -1260,15 +1260,11 @@ user-facing changes are described here.
 Files in the dashboard may now be sorted by last modified date or name
 ([943](https://github.com/jupyter/notebook/pull/943)):
 
-![image](/_static/images/dashboard-sort.png)
-
 ### Cell tags
 
 There is a new cell toolbar for adding _cell tags_
 ([2048](https://github.com/jupyter/notebook/pull/2048)):
 
-![image](/_static/images/cell-tags-toolbar.png)
-
 Cell tags are a lightweight way to customise the behaviour of tools
 working with notebooks; we're working on building support for them into
 tools like [nbconvert](https://nbconvert.readthedocs.io/en/latest/) and
@@ -1283,21 +1279,11 @@ future releases.
 The default styling for tables in the notebook has been updated
 ([1776](https://github.com/jupyter/notebook/pull/1776)).
 
-Before:
-
-![image](/_static/images/table-style-before.png)
-
-After:
-
-![image](/_static/images/table-style-after.png)
-
 ### Customise keyboard shortcuts
 
 You can now edit keyboard shortcuts for _Command Mode_ within the UI
 ([1347](https://github.com/jupyter/notebook/pull/1347)):
 
-![image](/_static/images/shortcut-editor.png)
-
 See the `Help > Edit Keyboard Shortcuts` menu item and follow the
 instructions.
 
@@ -1333,8 +1319,7 @@ instructions.
 - Load server extensions with ConfigManager so that merge happens
   recursively, unlike normal config values, to make it load more
   consistently with frontend extensions([2108](https://github.com/jupyter/notebook/pull/2108)).
-- The notebook server now supports the [bundler
-  API](https://jupyter-notebook.readthedocs.io/en/latest/extending/bundler_extensions.html)
+- The notebook server now supports the bundler API
   from the [jupyter_cms incubator
   project](https://github.com/jupyter-incubator/contentmanagement) ([1579](https://github.com/jupyter/notebook/pull/1579)).
 - The notebook server now provides information about kernel activity
@@ -1546,9 +1531,6 @@ UI changes:
   find the new location. (Click here to see a
   [screencast](https://cloud.githubusercontent.com/assets/335567/10711889/59665a5a-7a3e-11e5-970f-86b89592880c.gif)
   )
-
-  > ![image](/_static/images/cell-toolbar-41.png)
-
 - Added _Restart & Run All_ to the _Kernel_ menu. Users can also bind
   it to a keyboard shortcut on action
   `restart-kernel-and-run-all-cells`.
@@ -1558,19 +1540,13 @@ UI changes:
   such as cut/copy/paste, execute, and cell type conversions apply to
   all selected cells.
 
-  ![image](/_static/images/multi-select-41.png)
-
 - Added a command palette for executing Jupyter actions by name. Users
   press `Cmd/Ctrl-Shift-P` or click the new command palette icon on
   the toolbar.
 
-  ![image](/_static/images/command-palette-41.png)
-
 - Added a _Find and Replace_ dialog to the _Edit_ menu. Users can also
   press `F` in command mode to show the dialog.
 
-  ![image](/_static/images/find-replace-41.png)
-
 Other improvements:
 
 - Custom KernelManager methods can be Tornado coroutines, allowing

CONTRIBUTING.md

@@ -75,7 +75,7 @@ jlpm run build:test
 jlpm run test
 ```
 
-There are also end to end tests to cover higher level user interactions, located in the [`ui-tests`](./ui-tests) folder. To run these tests:
+There are also end to end tests to cover higher level user interactions, located in the `ui-tests` folder. To run these tests:
 
 ```bash
 cd ui-tests