Skip to content

Commit ff4df85

Browse files
committed
added some items in release process notes
1 parent 0753196 commit ff4df85

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

contributing.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ This is the release process for releasing `plotly.py` version `X.Y.Z` with
213213
`plotlywidget` version `A.B.C`.
214214

215215
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
217217
plotly.js has been updated. If neither of these is the case, there's no need
218218
to increment the `plotlywidget` version or to publish a new version to npm.
219219

@@ -297,17 +297,19 @@ And, you'll need the credentials file `~/.pypirc`. Request access from
297297
(plotly_dev) $ twine upload dist/plotly-X.Y.Zrc1*
298298
```
299299

300-
### Publish release candidate of `plotlywidget` to NPM
300+
### Publish release candidate of `plotlywidget` and `jupyterlab-plotly` to NPM
301301
Now, publish the release candidate of the `plotlywidget` NPM package.
302302

303303
```bash
304-
cd ./js
304+
cd ./packages/javascript/plotlywidget
305305
npm publish --access public --tag next
306306
```
307307

308308
The `--tag next` part ensures that users won't install this version unless
309309
they explicitly ask for the version or for the version wtih the `next` tag.
310310

311+
Do the same in the `jupyterlab-plotly` directory.
312+
311313
### Publish release candidate to plotly anaconda channel
312314
To publish package to the plotly anaconda channel you'll need to have the
313315
anaconda or miniconda distribution installed, and you'll need to have the
@@ -361,7 +363,9 @@ release candidate suffix from the following version strings:
361363

362364
- `plotly/_widget_version.py`:
363365
+ 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`
365369
+ Update `"version"` to `A.B.C`
366370

367371
Commit and push to the release branch.
@@ -431,6 +435,19 @@ Make "Release title" the same string as the tag.
431435

432436
Copy changelog section for this version as the "Describe this release"
433437

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+
434451
### Post announcement
435452
Post a simple announcement to the Plotly Python forum, with links to the
436453
README installation instructions and to the CHANGELOG.

0 commit comments

Comments
 (0)