@@ -213,7 +213,7 @@ This is the release process for releasing `plotly.py` version `X.Y.Z` with
213
213
` plotlywidget ` version ` A.B.C ` .
214
214
215
215
Note: The ` plotlywidget ` instructions must be followed if any change
216
- has been made in the ` js/ ` directory source code, OR if the version of
216
+ has been made in the ` packages/javascript ` directory source code, OR if the version of
217
217
plotly.js has been updated. If neither of these is the case, there's no need
218
218
to increment the ` plotlywidget ` version or to publish a new version to npm.
219
219
@@ -297,17 +297,19 @@ And, you'll need the credentials file `~/.pypirc`. Request access from
297
297
(plotly_dev) $ twine upload dist/plotly-X.Y.Zrc1*
298
298
```
299
299
300
- ### Publish release candidate of ` plotlywidget ` to NPM
300
+ ### Publish release candidate of ` plotlywidget ` and ` jupyterlab-plotly ` to NPM
301
301
Now, publish the release candidate of the ` plotlywidget ` NPM package.
302
302
303
303
``` bash
304
- cd ./js
304
+ cd ./packages/javascript/plotlywidget
305
305
npm publish --access public --tag next
306
306
```
307
307
308
308
The ` --tag next ` part ensures that users won't install this version unless
309
309
they explicitly ask for the version or for the version wtih the ` next ` tag.
310
310
311
+ Do the same in the ` jupyterlab-plotly ` directory.
312
+
311
313
### Publish release candidate to plotly anaconda channel
312
314
To publish package to the plotly anaconda channel you'll need to have the
313
315
anaconda or miniconda distribution installed, and you'll need to have the
@@ -361,7 +363,9 @@ release candidate suffix from the following version strings:
361
363
362
364
- ` plotly/_widget_version.py ` :
363
365
+ Update ` __frontend_version__ ` to ` ^A.B.C ` (Note the ` ^ ` prefix)
364
- - ` js/package.json `
366
+ - ` packages/javascript/plotlywidget/package.json `
367
+ + Update ` "version" ` to ` A.B.C `
368
+ - ` packages/javascript/jupyterlab-plotly/package.json `
365
369
+ Update ` "version" ` to ` A.B.C `
366
370
367
371
Commit and push to the release branch.
@@ -431,6 +435,19 @@ Make "Release title" the same string as the tag.
431
435
432
436
Copy changelog section for this version as the "Describe this release"
433
437
438
+ ### Upgrade doc requirements and API doc
439
+
440
+ Files to be updated:
441
+ - ` doc/apidoc/conf.py ` with new version number
442
+ - ` doc/requirements.txt `
443
+ - ` binder/requirements.txt `
444
+
445
+ ### Synchronize master and doc-prod branches
446
+
447
+ doc-prod should already have been merged on a regular basis into master, but
448
+ start doing it first. Then merge master into doc-prod to deploy the doc related
449
+ to features in the release.
450
+
434
451
### Post announcement
435
452
Post a simple announcement to the Plotly Python forum, with links to the
436
453
README installation instructions and to the CHANGELOG.
0 commit comments