Skip to content

Commit

Permalink
Update 4.2.x branch config and links (#16324)
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski committed May 14, 2024
1 parent 7ae2d43 commit 75cc8fe
Show file tree
Hide file tree
Showing 37 changed files with 99 additions and 99 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Thanks for contributing to JupyterLab!
Please fill out the following items to submit a pull request.
See the contributing guidelines for more information:
https://github.com/jupyterlab/jupyterlab/blob/main/CONTRIBUTING.md
https://github.com/jupyterlab/jupyterlab/blob/4.2.x/CONTRIBUTING.md
-->

## References
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/check-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Check Release

on:
push:
branches: [main]
branches: [4.2.x]
pull_request:
branches: [main]
branches: [4.2.x]
release:
types: [published]

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ name: "CodeQL"

on:
push:
branches: [main]
branches: [4.2.x]
pull_request:
# The branches below must be a subset of the branches above
branches: [main]
branches: [4.2.x]
schedule:
- cron: '0 8 * * 3'

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docker-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ on:
schedule:
- cron: '0 0 * * *'
push:
branches: [main]
branches: [4.2.x]
pull_request:
branches: [main]
branches: [4.2.x]

jobs:
docker:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/linuxjs-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Linux JS Tests

on:
push:
branches: [main]
branches: [4.2.x]
pull_request:
branches: [main]
branches: [4.2.x]
release:
types: [published]

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/linuxtests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Linux Tests

on:
push:
branches: [main]
branches: [4.2.x]
pull_request:
branches: [main]
branches: [4.2.x]
release:
types: [published]

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/macostests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: macOS Tests

on:
push:
branches: [main]
branches: [4.2.x]
pull_request:
branches: [main]
branches: [4.2.x]
release:
types: [published]

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/windowstests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: Windows Tests

on:
push:
branches: [main]
branches: [4.2.x]
pull_request:
branches: [main]
branches: [4.2.x]
release:
types: [published]

Expand Down
56 changes: 28 additions & 28 deletions CHANGELOG.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ If you're reading this section, you're probably interested in contributing to
JupyterLab. Welcome and thanks for your interest in contributing!

Please take a look at Contributing to Jupyterlab on
[Read the Docs](https://jupyterlab.readthedocs.io/en/latest/developer/contributing.html) or
[Read the Docs](https://jupyterlab.readthedocs.io/en/stable/developer/contributing.html) or
[Repo docs](docs/source/developer/contributing.rst) (for the latest).
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ via [PyPI](https://pypi.org/search/?q=jupyterlab&o=-created&c=Framework+%3A%3A+J
conda, and other package managers. The _source_ extensions can be installed
directly from npm (search for [jupyterlab-extension](https://www.npmjs.com/search?q=keywords:jupyterlab-extension)) but require an additional build step.
You can also find JupyterLab extensions exploring GitHub topic [jupyterlab-extension](https://github.com/topics/jupyterlab-extension).
To learn more about extensions, see the [user documentation](https://jupyterlab.readthedocs.io/en/latest/user/extensions.html).
To learn more about extensions, see the [user documentation](https://jupyterlab.readthedocs.io/en/stable/user/extensions.html).

Read the current JupyterLab documentation on [ReadTheDocs](http://jupyterlab.readthedocs.io/en/stable/).

Expand Down Expand Up @@ -63,7 +63,7 @@ If you use [conda](https://docs.conda.io/en/latest/), [mamba](https://mamba.read
```
If installing using `pip install --user`, you must add the user-level `bin` directory to your `PATH` environment variable in order to launch `jupyter lab`. If you are using a Unix derivative (e.g., FreeBSD, GNU/Linux, macOS), you can do this by running `export PATH="$HOME/.local/bin:$PATH"`. If you are using a macOS version that comes with Python 2, run `pip3` instead of `pip`.

For more detailed instructions, consult the [installation guide](http://jupyterlab.readthedocs.io/en/latest/getting_started/installation.html). Project installation instructions from the git sources are available in the [contributor documentation](CONTRIBUTING.md).
For more detailed instructions, consult the [installation guide](http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html). Project installation instructions from the git sources are available in the [contributor documentation](CONTRIBUTING.md).

#### Installing with Previous Versions of Jupyter Notebook

Expand All @@ -81,7 +81,7 @@ Start up JupyterLab using:
jupyter lab
```

JupyterLab will open automatically in the browser. See the [documentation](http://jupyterlab.readthedocs.io/en/latest/getting_started/starting.html) for additional details.
JupyterLab will open automatically in the browser. See the [documentation](http://jupyterlab.readthedocs.io/en/stable/getting_started/starting.html) for additional details.

If you encounter an error like "Command 'jupyter' not found", please make sure `PATH` environment variable is set correctly. Alternatively, you can start up JupyterLab using `~/.local/bin/jupyter lab` without changing the `PATH` environment variable.

Expand All @@ -93,7 +93,7 @@ The latest versions of the following browsers are currently _known to work_:
- Chrome
- Safari

See our [documentation](http://jupyterlab.readthedocs.io/en/latest/getting_started/installation.html) for additional details.
See our [documentation](http://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html) for additional details.

---

Expand All @@ -103,7 +103,7 @@ We encourage you to ask questions on the [Discourse forum](https://discourse.jup

### Bug report

To report a bug please read the [guidelines](https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html) and then open a [Github issue](https://github.com/jupyterlab/jupyterlab/issues/new?labels=bug%2C+status%3ANeeds+Triage&template=bug_report.md). To keep resolved issues self-contained, the [lock bot](https://github.com/apps/lock) will lock closed issues as resolved after a period of inactivity. If a related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.
To report a bug please read the [guidelines](https://jupyterlab.readthedocs.io/en/stable/getting_started/issue.html) and then open a [Github issue](https://github.com/jupyterlab/jupyterlab/issues/new?labels=bug%2C+status%3ANeeds+Triage&template=bug_report.md). To keep resolved issues self-contained, the [lock bot](https://github.com/apps/lock) will lock closed issues as resolved after a period of inactivity. If a related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.

### Feature request

Expand All @@ -115,18 +115,18 @@ We also welcome suggestions for new features as they help make the project more

### Extending JupyterLab

To start developing an extension for JupyterLab, see the [developer documentation](https://jupyterlab.readthedocs.io/en/latest/extension/extension_dev.html) and the [API docs](https://jupyterlab.readthedocs.io/en/latest/api/).
To start developing an extension for JupyterLab, see the [developer documentation](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html) and the [API docs](https://jupyterlab.readthedocs.io/en/stable/api/).

### Contributing

To contribute code or documentation to JupyterLab itself, please read the [contributor documentation](https://jupyterlab.readthedocs.io/en/latest/developer/contributing.html).
To contribute code or documentation to JupyterLab itself, please read the [contributor documentation](https://jupyterlab.readthedocs.io/en/stable/developer/contributing.html).

JupyterLab follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html).

### License

JupyterLab uses a shared copyright model that enables all contributors to maintain the
copyright on their contributions. All code is licensed under the terms of the revised [BSD license](https://github.com/jupyterlab/jupyterlab/blob/main/LICENSE).
copyright on their contributions. All code is licensed under the terms of the revised [BSD license](https://github.com/jupyterlab/jupyterlab/blob/4.2.x/LICENSE).

### Team

Expand Down
10 changes: 5 additions & 5 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,9 @@ These lines:
- [ ] https://github.com/jupyterlab/jupyter-renderers
- [ ] Publish a release (with a **updated tag**) to the [extension template](https://github.com/jupyterlab/extension-template/releases) with the new JupyterLab version
- [ ] Update the extension examples:
- [ ] [Notebook toolbar button](https://github.com/jupyterlab/jupyterlab/blob/main/docs/source/extension/notebook.rst#adding-a-button-to-the-toolbar)
- [ ] [Notebook widget](https://github.com/jupyterlab/jupyterlab/blob/main/docs/source/extension/notebook.rst#adding-a-widget-to-the-notebook-header)
- [ ] Update the [extension tutorial](https://github.com/jupyterlab/jupyterlab/blob/main/RELEASE.md#updating-the-extension-tutorial)
- [ ] [Notebook toolbar button](https://github.com/jupyterlab/jupyterlab/blob/4.2.x/docs/source/extension/notebook.rst#adding-a-button-to-the-toolbar)
- [ ] [Notebook widget](https://github.com/jupyterlab/jupyterlab/blob/4.2.x/docs/source/extension/notebook.rst#adding-a-widget-to-the-notebook-header)
- [ ] Update the [extension tutorial](https://github.com/jupyterlab/jupyterlab/blob/4.2.x/RELEASE.md#updating-the-extension-tutorial)
- [ ] At this point, there may have been some more commits merged. Run `python scripts/milestone_check.py` to check the issues assigned to this milestone one more time. Update changelog if necessary.

Now do the actual final release:
Expand All @@ -276,7 +276,7 @@ Now do the actual final release:
- [ ] Update the API [docs](#updating-api-docs)
- [ ] Merge the PRs on the other repos and set the default branch of the
xckd repo
- [ ] Publish to [conda-forge](https://github.com/jupyterlab/jupyterlab/blob/main/RELEASE.md#publishing-to-conda-forge).
- [ ] Publish to [conda-forge](https://github.com/jupyterlab/jupyterlab/blob/4.2.x/RELEASE.md#publishing-to-conda-forge).

After a few days (to allow for possible patch releases), set up development for
the next release:
Expand All @@ -285,7 +285,7 @@ the next release:
- [ ] Put the commit and tags to main
- [ ] Run `npm run publish:all` to publish the packages
- [ ] Release the other repos as appropriate
- [ ] Update version for [binder](https://github.com/jupyterlab/jupyterlab/blob/main/RELEASE.md#update-version-for-binder)
- [ ] Update version for [binder](https://github.com/jupyterlab/jupyterlab/blob/4.2.x/RELEASE.md#update-version-for-binder)

### Updating the extension tutorial

Expand Down
4 changes: 2 additions & 2 deletions buildutils/src/ensure-repo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ type CoreData = Map<string, any>;
// All other release branches should target a specific named version
const URL_CONFIG = {
source: 'main',
target: 'main',
rtdVersion: 'latest'
target: '4.2.x',
rtdVersion: 'stable'
};

// Data to ignore.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ def document_plugins_tokens_list(list_path: Path, output_path: Path) -> None:
html_context = {
"github_user": "jupyterlab", # Username
"github_repo": "jupyterlab", # Repo name
"github_version": "main", # Version
"github_version": "4.2.x", # Version
"doc_path": "docs/source/", # Path in the checkout to the docs root
}

Expand Down
2 changes: 1 addition & 1 deletion docs/source/developer/accessibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ be tempting to pick a color and apply it to the part of the UI that you are
working on. However, it quickly becomes unmanageable to have color values spread
throughout the app across different CSS files. Therefore, the JupyterLab
codebase defines a set of `color variables
<https://github.com/jupyterlab/jupyterlab/blob/main/packages/theme-light-extension/style/variables.css>`__
<https://github.com/jupyterlab/jupyterlab/blob/4.2.x/packages/theme-light-extension/style/variables.css>`__
that can be used for borders, icons, and such. If you're adding any CSS that
needs a color value, please use one of the variables defined.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/developer/components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ IDE-like experience. However, developers are encouraged to use these to bring
to life their own visions of what a computational environment should look
like.

The JupyterLab repository has `many examples <https://github.com/jupyterlab/jupyterlab/tree/main/examples>`_
The JupyterLab repository has `many examples <https://github.com/jupyterlab/jupyterlab/tree/4.2.x/examples>`_
to get you started.

The ``examples`` directory contains:
Expand Down
6 changes: 3 additions & 3 deletions docs/source/developer/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ Installing Node.js and jlpm
Building JupyterLab from its GitHub source code requires Node.js. The
development version requires Node.js version 20+, as defined in the
``engines`` specification in
`dev_mode/package.json <https://github.com/jupyterlab/jupyterlab/blob/main/dev_mode/package.json>`__.
`dev_mode/package.json <https://github.com/jupyterlab/jupyterlab/blob/4.2.x/dev_mode/package.json>`__.

If you use `conda <https://conda.io>`__, you can get it with:

Expand Down Expand Up @@ -677,7 +677,7 @@ Visual Regression and UI Tests
------------------------------

As part of JupyterLab CI workflows, UI tests are run with visual regression checks.
`Galata <https://github.com/jupyterlab/jupyterlab/tree/main/galata>`__ is used for UI
`Galata <https://github.com/jupyterlab/jupyterlab/tree/4.2.x/galata>`__ is used for UI
testing. Galata provides `Playwright <https://playwright.dev>`__ helpers to control and
inspect JupyterLab UI programmatically.

Expand Down Expand Up @@ -719,7 +719,7 @@ Main reasons for UI test failures are:
The bot will react with +1 emoji to indicate that the run started and then comment
back once it concluded.

For more information on UI Testing, please read the `UI Testing developer documentation <https://github.com/jupyterlab/jupyterlab/blob/main/galata/README.md>`__
For more information on UI Testing, please read the `UI Testing developer documentation <https://github.com/jupyterlab/jupyterlab/blob/4.2.x/galata/README.md>`__
and `Playwright documentation <https://playwright.dev/docs/intro>`__.

Good Practices for Integration tests
Expand Down
2 changes: 1 addition & 1 deletion docs/source/developer/css.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ CSS variable usage
^^^^^^^^^^^^^^^^^^

JupyterLab includes a default set of CSS variables in the file
`packages/theme-light-extension/style/variables.css <https://github.com/jupyterlab/jupyterlab/blob/main/packages/theme-light-extension/style/variables.css>`_.
`packages/theme-light-extension/style/variables.css <https://github.com/jupyterlab/jupyterlab/blob/4.2.x/packages/theme-light-extension/style/variables.css>`_.

To ensure consistent design in JupyterLab, all built-in and third party
extensions should use these variables in their styles if at all
Expand Down
2 changes: 1 addition & 1 deletion docs/source/developer/repo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In particular, there are many TypeScript packages and a single Python package.
The Python package contains server-side code, and also distributes
the bundled-and-compiled TypeScript code.

See the `Contributing Guidelines <https://github.com/jupyterlab/jupyterlab/blob/main/CONTRIBUTING.md>`__
See the `Contributing Guidelines <https://github.com/jupyterlab/jupyterlab/blob/4.2.x/CONTRIBUTING.md>`__
for detailed developer installation instructions.

Directories
Expand Down
12 changes: 6 additions & 6 deletions docs/source/extension/extension_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ A mime renderer plugin is an object with the fields listed in the
`rendermime-interfaces IExtension <../api/interfaces/rendermime_interfaces.IRenderMime.IExtension.html>`__
object.

JupyterLab has a `pdf mime renderer extension <https://github.com/jupyterlab/jupyterlab/tree/main/packages/pdf-extension>`__, for example. In core JupyterLab, this is used to view pdf files and view pdf data mime data in a notebook.
JupyterLab has a `pdf mime renderer extension <https://github.com/jupyterlab/jupyterlab/tree/4.2.x/packages/pdf-extension>`__, for example. In core JupyterLab, this is used to view pdf files and view pdf data mime data in a notebook.

We have a `MIME renderer example <https://github.com/jupyterlab/extension-examples/tree/master/mimerenderer>`__ walking through creating a mime renderer extension which adds mp4 video rendering to JupyterLab. The `extension template <https://github.com/jupyterlab/extension-template>`_ supports MIME renderer extensions.

Expand All @@ -210,7 +210,7 @@ A theme is a special application plugin that registers a theme with the ``ThemeM

The extension package containing the theme plugin must include all static assets that are referenced by ``@import`` in its theme CSS files. Local URLs can be used to reference files relative to the location of the referring sibling CSS files. For example ``url('images/foo.png')`` or ``url('../foo/bar.css')`` can be used to refer local files in the theme. Absolute URLs (starting with a ``/``) or external URLs (e.g. ``https:``) can be used to refer to external assets.

See the `JupyterLab Light Theme <https://github.com/jupyterlab/jupyterlab/tree/main/packages/theme-light-extension>`__ for an example.
See the `JupyterLab Light Theme <https://github.com/jupyterlab/jupyterlab/tree/4.2.x/packages/theme-light-extension>`__ for an example.

See the `TypeScript extension template <https://github.com/jupyterlab/extension-template>`__ (choosing ``theme`` as ``kind`` ) for a quick start to developing a theme plugin.

Expand All @@ -221,7 +221,7 @@ Source Extensions

A source extension is a JavaScript (npm) package that exports one or more plugins. All JupyterLab extensions are developed as source extensions (for example, prebuilt extensions are built from source extensions).

A source extension has metadata in the ``jupyterlab`` field of its ``package.json`` file. The `JSON schema <https://github.com/jupyterlab/jupyterlab/blob/main/builder/metadata_schema.json>`__ for the metadata is distributed in the ``@jupyterlab/builder`` package.
A source extension has metadata in the ``jupyterlab`` field of its ``package.json`` file. The `JSON schema <https://github.com/jupyterlab/jupyterlab/blob/4.2.x/builder/metadata_schema.json>`__ for the metadata is distributed in the ``@jupyterlab/builder`` package.

We will talk about each ``jupyterlab`` metadata field in ``package.json`` for source extensions below.

Expand Down Expand Up @@ -286,10 +286,10 @@ For example, the JupyterLab ``filebrowser-extension`` package exports the ``@jup
"schemaDir": "schema",
}

The file browser setting schema file (which specifies some default keyboard shortcuts and other settings for the filebrowser) is located in ``schema/browser.json`` (see `here <https://github.com/jupyterlab/jupyterlab/blob/main/packages/filebrowser-extension/schema/browser.json>`__).
The file browser setting schema file (which specifies some default keyboard shortcuts and other settings for the filebrowser) is located in ``schema/browser.json`` (see `here <https://github.com/jupyterlab/jupyterlab/blob/4.2.x/packages/filebrowser-extension/schema/browser.json>`__).

See the
`fileeditor-extension <https://github.com/jupyterlab/jupyterlab/tree/main/packages/fileeditor-extension>`__
`fileeditor-extension <https://github.com/jupyterlab/jupyterlab/tree/4.2.x/packages/fileeditor-extension>`__
for another example of an extension that uses settings.

Please ensure that the schema files are included in the ``files`` metadata in ``package.json``.
Expand Down Expand Up @@ -534,7 +534,7 @@ Custom webpack configuration can be used to enable webpack features, configure a
}
};
This custom config will be merged with the `prebuilt extension config <https://github.com/jupyterlab/jupyterlab/blob/main/builder/src/extensionConfig.ts>`_
This custom config will be merged with the `prebuilt extension config <https://github.com/jupyterlab/jupyterlab/blob/4.2.x/builder/src/extensionConfig.ts>`_
when building the prebuilt extension.

.. _prebuilt_dev_workflow:
Expand Down

0 comments on commit 75cc8fe

Please sign in to comment.