Skip to content

Commit cb488ff

Browse files
committed
Remove npm from release instructions
1 parent 612ceec commit cb488ff

File tree

1 file changed

+5
-26
lines changed

1 file changed

+5
-26
lines changed

Diff for: release.md

+5-26
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,11 @@
22
# How to release plotly packages
33

44
There are 3 Python packages (`plotly`, `plotly-geo` and `chart-studio`) which need to be
5-
published to PyPI and conda, and 1 JS packages (`jupyterlab-plotly`)
6-
which need to be published to NPM. In addition, there are various changelogs, github
7-
releases and forum announcements to do :)
5+
published to PyPI and conda. In addition, there are various changelogs, github releases and forum announcements to do :)
86

97
## Release process - `plotly` package and extensions
108

11-
This is the release process for releasing `plotly.py` version `X.Y.Z` with
12-
`jupyterlab-plotly` with matching versions.
13-
14-
> Note: it's easier to lock the JS extension and Python versions together, even if it means we occasionally
15-
> push no-change versions to NPM/PyPI/Conda.
9+
This is the release process for releasing `plotly.py` version `X.Y.Z`.
1610

1711
### Finalize changelog
1812

@@ -39,9 +33,9 @@ Manually update the versions to `X.Y.Z` in the files specified below.
3933
+ this must be done at this point because the README gets baked into PyPI
4034
- `packages/python/plotly/plotly/_widget_version.py`:
4135
+ Update `__frontend_version__` to `^X.Y.Z` (Note the `^` prefix)
42-
- `packages/javascript/jupyterlab-plotly/package.json`
36+
- `packages/python/plotly/js/package.json`
4337
+ Update `"version"` to `X.Y.Z`
44-
- `packages/javascript/jupyterlab-plotly/package-lock.json`
38+
- `packages/python/plotly/js/package-lock.json`
4539
+ Update `"version"` to `X.Y.Z` in two places (to avoid dirty repo after rebuild)
4640
- Commit your changes on the branch:
4741
+ `git commit -a -m "version changes for vX.Y.Z"`
@@ -63,7 +57,7 @@ The `full_build` job in the `release_build` workflow in CircleCI produces a tarb
6357

6458
**Note: if any of the version numbers are not simply `X.Y.Z` but include some kind of git hash, then this is a dirty build and you'll need to clean up whatever is dirtying the tree and follow the instructions above to trigger the build again.** (That said, you can do QA on dirty builds, you just can't publish them.)
6559

66-
To locally install the PyPI dist, make sure you have an environment with JupyterLab 3 installed (maybe one created with `conda create -n condatest python=3.10 jupyterlab ipywidgets pandas`):
60+
To locally install the PyPI dist, make sure you have an environment with JupyterLab installed (maybe one created with `conda create -n condatest python=3.10 jupyter anywidget pandas`):
6761

6862
- `tar xzf output.tgz`
6963
- `pip uninstall plotly`
@@ -76,8 +70,6 @@ To locally install the Conda dist (generally do this in a different, clean envir
7670
- `pip uninstall plotly` (just in case!)
7771
- `conda install path/to/output/plotly-X.Y.Z.tar.bz2`
7872

79-
It's more complicated to locally install the NPM bundle, as you'll need to have a JupyterLab 2 environment installed... Undocumented for now :see_no_evil:.
80-
8173
You'll want to check, in both Lab and Notebook, **in a brand new notebook in each** so that there is no caching of previous results, that `go.Figure()` and `go.FigureWidget()` work without error.
8274

8375
If something is broken, you'll need to fix it and trigger the build again (see above section).
@@ -94,13 +86,6 @@ Publishing to PyPI:
9486
(plotly_dev) $ twine upload plotly-X.Y.Z*
9587
```
9688

97-
Publishing to NPM:
98-
99-
```bash
100-
(plotly_dev) $ cd path/to/output
101-
(plotly_dev) $ npm publish jupyterlab-plotly-X.Y.Z.tgz
102-
```
103-
10489
Publishing to `plotly` conda channel (make sure you have run `conda install anaconda-client` to get the `anaconda` command):
10590

10691
```
@@ -153,12 +138,6 @@ PyPI RC (no special flags, just the `rc1` suffix):
153138
(plotly_dev) $ twine upload dist/plotly-X.Y.Zrc1*
154139
```
155140

156-
NPM RC:
157-
158-
```bash
159-
npm publish --access public --tag next jupyterlab-plotly.*
160-
```
161-
162141
The `--tag next` part ensures that users won't install this version unless
163142
they explicitly ask for the version or for the version with the `next` tag.
164143

0 commit comments

Comments
 (0)