Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

6.2.0 release prep #267

Merged
merged 5 commits into from
Aug 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ include package.json
include install.json
include ts*.json

include yarn.lock

graft dask_labextension/labextension

# Javascript files
Expand Down
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,22 +213,35 @@ jupyter serverextension enable --sys-prefix dask_labextension

## Publishing

This application is distributed as two subpackages.

The JupyterLab frontend part is published to [npm](https://www.npmjs.com/package/dask-labextension),
and the server-side part to [PyPI](https://pypi.org/project/dask-labextension/).

Releases for both packages are done with the `jlpm` tool, `git` and Travis CI.
This extension contains a front-end component written in TypeScript
and a back-end component written in Python.
The front-end is compiled to Javascript during the build process
and is distributed as static assets along with the Python package.

_Note: Package versions are not prefixed with the letter `v`. You will need to disable this._

```console
$ jlpm config set version-tag-prefix ""
```

Making a release
### Release process

```console
$ jlpm version [--major|--minor|--patch] # updates package.json and creates git commit and tag
$ git push upstream main && git push upstream main --tags # pushes tags to GitHub which triggers Travis CI to build and deploy
This requires `node`, `build`, and `twine` to be installed.

```bash
jlpm version [--major|--minor|--patch] # updates package.json and creates git commit and tag
git push upstream main && git push upstream main --tags # pushes to GitHub
python -m build . # Build the package
twine upload dist/* # Upload the package to PyPI
```

### Handling Javascript package version conflicts

Unlike Python, Javascript packages can include more than one version of the same dependency.
Usually the `yarn` package manager handles this okay, but occasionally you might end up with conflicting versions,
or with unexpected package bloat.
You can try to fix this by deduplicating dependencies:

```bash
jlpm yarn-deduplicate -s fewer
```
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@
"prettier": "^2.1.1",
"rimraf": "^3.0.2",
"typescript": "~4.1.3",
"yarn": "1.22.0"
"yarn": "1.22.0",
"yarn-deduplicate": "^5.0.0"
},
"resolutions": {
"@types/react": "~17.0.0"
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
"bokeh >=1.0.0,!=2.0.0",
"distributed>=1.24.1",
"jupyter-server-proxy>=1.3.2",
"jupyterlab>=3.0.0",
"jupyterlab>=3.0.0,<4",
],
zip_safe=False,
include_package_data=True,
Expand Down
Loading