Skip to content

Commit

Permalink
add mdformat plugins (jupyterlab#13335)
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 authored Nov 17, 2022
1 parent 3a19f96 commit c41be9b
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 30 deletions.
2 changes: 2 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ repos:
rev: 0.7.16
hooks:
- id: mdformat
additional_dependencies:
[mdformat-gfm, mdformat-frontmatter, mdformat-footnote]

- repo: https://github.com/sirosen/check-jsonschema
rev: 0.19.1
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6415,10 +6415,10 @@ contains many enhancements, bugfixes, and refinements, including:
- Handle asynchronous comm messages in the services library more
correctly (Note: this means `@jupyterlab/services` is now at version
2.0!)
([\[#4115\](https://github.com/jupyterlab/jupyterlab/issues/4115)](https://github.com/jupyterlab/jupyterlab/pull/4115)).
(\[[#4115](https://github.com/jupyterlab/jupyterlab/issues/4115)\](https://github.com/jupyterlab/jupyterlab/pull/4115)).
- Display the kernel banner in the console when a kernel is restarted
to mark the restart
([\[#3663\](https://github.com/jupyterlab/jupyterlab/issues/3663)](https://github.com/jupyterlab/jupyterlab/pull/3663)).
(\[[#3663](https://github.com/jupyterlab/jupyterlab/issues/3663)\](https://github.com/jupyterlab/jupyterlab/pull/3663)).
- Many tweaks to the UI, as well as better error handling.

## [Beta 1 (v0.31.0)](https://github.com/jupyterlab/jupyterlab/releases/tag/v0.31.0)
Expand Down
56 changes: 28 additions & 28 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,50 +247,50 @@ These lines:

## Post release candidate checklist

- \[ \] Modify and run `python scripts/milestone_check.py` to check the issues assigned to this milestone
- \[ \] Write [release highlights](CHANGELOG.md), starting with:
- [ ] Modify and run `python scripts/milestone_check.py` to check the issues assigned to this milestone
- [ ] Write [release highlights](CHANGELOG.md), starting with:
```bash
loghub jupyterlab/jupyterlab -m XXX -t $GITHUB_TOKEN --template scripts/release_template.txt
```
- \[ \] Test the release candidate in a clean environment
- \[ \] Make sure the CI builds pass
- [ ] Test the release candidate in a clean environment
- [ ] Make sure the CI builds pass
- The build will fail if we publish a new package because by default it is
private. Use `npm access public @jupyterlab/<name>` to make it public.
- The build will fail if we forget to include `style/` in the `files:`
of a package (it will fail on the `jupyter lab build` command because
webpack cannot find the referenced styles to import.
- \[ \] Update the other repos:
- \[ \] https://github.com/jupyterlab/extension-cookiecutter-js
- \[ \] https://github.com/jupyterlab/extension-cookiecutter-ts
- \[ \] https://github.com/jupyterlab/mimerender-cookiecutter
- \[ \] https://github.com/jupyterlab/mimerender-cookiecutter-ts
- \[ \] https://github.com/jupyterlab/theme-cookiecutter
- \[ \] https://github.com/jupyterlab/jupyter-renderers
- \[ \] Add a tag to [ts cookiecutter](https://github.com/jupyterlab/extension-cookiecutter-ts) with the new JupyterLab version
- \[ \] Update the extension examples:
- \[ \] [Notebook toolbar button](https://github.com/jupyterlab/jupyterlab/blob/master/docs/source/extension/notebook.rst#adding-a-button-to-the-toolbar)
- \[ \] Update the [extension tutorial](https://github.com/jupyterlab/jupyterlab/blob/master/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.
- [ ] Update the other repos:
- [ ] https://github.com/jupyterlab/extension-cookiecutter-js
- [ ] https://github.com/jupyterlab/extension-cookiecutter-ts
- [ ] https://github.com/jupyterlab/mimerender-cookiecutter
- [ ] https://github.com/jupyterlab/mimerender-cookiecutter-ts
- [ ] https://github.com/jupyterlab/theme-cookiecutter
- [ ] https://github.com/jupyterlab/jupyter-renderers
- [ ] Add a tag to [ts cookiecutter](https://github.com/jupyterlab/extension-cookiecutter-ts) with the new JupyterLab version
- [ ] Update the extension examples:
- [ ] [Notebook toolbar button](https://github.com/jupyterlab/jupyterlab/blob/master/docs/source/extension/notebook.rst#adding-a-button-to-the-toolbar)
- [ ] Update the [extension tutorial](https://github.com/jupyterlab/jupyterlab/blob/master/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:

- \[ \] Run `jlpm run bumpversion release` to switch to final release
- \[ \] Push the commit and tags to master
- \[ \] Run `npm run publish:all` to publish the packages
- \[ \] Create a branch for the release and push to GitHub
- \[ \] Update the API [docs](#updating-api-docs)
- \[ \] Merge the PRs on the other repos and set the default branch of the
- [ ] Run `jlpm run bumpversion release` to switch to final release
- [ ] Push the commit and tags to master
- [ ] Run `npm run publish:all` to publish the packages
- [ ] Create a branch for the release and push to GitHub
- [ ] 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/master/RELEASE.md#publishing-to-conda-forge).
- [ ] Publish to [conda-forge](https://github.com/jupyterlab/jupyterlab/blob/master/RELEASE.md#publishing-to-conda-forge).

After a few days (to allow for possible patch releases), set up development for
the next release:

- \[ \] Run `jlpm run bumpversion minor` to bump to alpha for the next alpha release
- \[ \] Put the commit and tags to master
- \[ \] 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/master/RELEASE.md#update-version-for-binder)
- [ ] Run `jlpm run bumpversion minor` to bump to alpha for the next alpha release
- [ ] Put the commit and tags to master
- [ ] 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/master/RELEASE.md#update-version-for-binder)

### Updating the extension tutorial

Expand Down

0 comments on commit c41be9b

Please sign in to comment.