Skip to content

Commit 3cfa991

Browse files
slight shuffle in release instructions
1 parent 6c463ee commit 3cfa991

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

Diff for: release.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,12 @@ specified below.
4747
+ Update `"version"` to `X.Y.Z`
4848
+ Ensure you're using `node` version 12 and `npm` version 6 to minimize diffs to `package-lock.json`
4949
+ Run `rm -rf node_modules && npm install && npm run build`
50+
- This the last good time to install the extensions locally and check that everything works in dev mode
5051
- Run `git diff` and ensure that only the files you modified and the build artifacts have changed
5152
- Ensure that the diff in `package-lock.json` seems sane
52-
- Commit and push. (NOTE: once pushed, the Github readme refers to the new versions, so don't stop here!)
53-
54-
### Tag the release
55-
56-
Make sure tests pass CI checks, then tag this commit as `vX.Y.Z` (e.g. `v3.1.1`) and push the tag.
57-
58-
```bash
59-
(plotly_dev) $ git checkout master
60-
(plotly_dev) $ git stash
61-
(plotly_dev) $ git pull origin master
62-
(plotly_dev) $ git tag vX.Y.Z
63-
(plotly_dev) $ git push origin vX.Y.Z
64-
```
53+
- Commit and tag but *don't push* until after everything is available on NPM/PyPI/Conda (see below):
54+
+ `git commit -a -m "release vX.Y.Z"`
55+
+ `git tag vX.Y.Z`
6556

6657
### Publish JS Extensions to NPM
6758

@@ -75,11 +66,14 @@ cd packages/javascript/plotlywidget
7566
npm run build && npm publish --access public
7667
```
7768

69+
Final checks could be done here if desired.
70+
7871
### Publishing to PyPI
7972

80-
Build and publish the final version to PyPI
73+
Build and publish the final version to PyPI.
8174

8275
```bash
76+
(plotly_dev) $ git status # make sure it's not dirty!
8377
(plotly_dev) $ cd packages/python/plotly
8478
(plotly_dev) $ rm -rf dist
8579
(plotly_dev) $ python setup.py sdist bdist_wheel
@@ -115,7 +109,12 @@ provides, which looks something like this:
115109
$ anaconda upload /path/to/anaconda3/conda-bld/noarch/plotly-*.tar.bz2
116110
```
117111

118-
### Add GitHub Release entry
112+
### Push the commit and add GitHub Release entry
113+
114+
```bash
115+
(plotly_dev) $ git push origin master
116+
(plotly_dev) $ git push origin vX.Y.Z
117+
```
119118

120119
1. Go to https://github.com/plotly/plotly.py/releases and "Draft a new release"
121120
2. Enter the `vX.Y.Z` tag you created already above and make "Release title" the same string as the tag.

0 commit comments

Comments
 (0)