Skip to content

Commit 51fa1ee

Browse files
Merge pull request #2128 from plotly/contributing
added some items in release process notes
2 parents 4bf740b + 2b06173 commit 51fa1ee

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

contributing.md

Lines changed: 24 additions & 5 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

@@ -253,7 +253,9 @@ Note that the conda installation instructions must include
253253
"-c plotly/lable/test" rather than "-c plotly" in order to install the
254254
release candidate version.
255255

256-
Commit Changelog and README updates.
256+
Update the `doc/python/getting-started.md` file with the same version numbers.
257+
258+
Commit Changelog, README and getting-started updates.
257259

258260
### Bump to release candidate version
259261
1) Manually update the plotlywidget version to `A.B.C-rc.1` in the files
@@ -297,17 +299,19 @@ And, you'll need the credentials file `~/.pypirc`. Request access from
297299
(plotly_dev) $ twine upload dist/plotly-X.Y.Zrc1*
298300
```
299301

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

303305
```bash
304-
cd ./js
306+
cd ./packages/javascript/plotlywidget
305307
npm publish --access public --tag next
306308
```
307309

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

313+
Do the same in the `jupyterlab-plotly` directory.
314+
311315
### Publish release candidate to plotly anaconda channel
312316
To publish package to the plotly anaconda channel you'll need to have the
313317
anaconda or miniconda distribution installed, and you'll need to have the
@@ -361,7 +365,9 @@ release candidate suffix from the following version strings:
361365

362366
- `plotly/_widget_version.py`:
363367
+ Update `__frontend_version__` to `^A.B.C` (Note the `^` prefix)
364-
- `js/package.json`
368+
- `packages/javascript/plotlywidget/package.json`
369+
+ Update `"version"` to `A.B.C`
370+
- `packages/javascript/jupyterlab-plotly/package.json`
365371
+ Update `"version"` to `A.B.C`
366372

367373
Commit and push to the release branch.
@@ -431,6 +437,19 @@ Make "Release title" the same string as the tag.
431437

432438
Copy changelog section for this version as the "Describe this release"
433439

440+
### Upgrade doc requirements and API doc
441+
442+
Files to be updated:
443+
- `doc/apidoc/conf.py` with new version number
444+
- `doc/requirements.txt`
445+
- `binder/requirements.txt`
446+
447+
### Synchronize master and doc-prod branches
448+
449+
doc-prod should already have been merged on a regular basis into master, but
450+
start doing it first. Then merge master into doc-prod to deploy the doc related
451+
to features in the release.
452+
434453
### Post announcement
435454
Post a simple announcement to the Plotly Python forum, with links to the
436455
README installation instructions and to the CHANGELOG.

0 commit comments

Comments
 (0)