You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: release.md
+4-13Lines changed: 4 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,28 +24,21 @@ a link to the plotly.js CHANGELOG.
24
24
25
25
Manually update the versions to `X.Y.Z` in the files specified below.
26
26
27
+
-`pyproject.toml`
28
+
+ update version
27
29
-`CHANGELOG.md`
28
30
+ update the release date
29
31
- Commit your changes on the branch:
30
32
+`git commit -a -m "version changes for vX.Y.Z"`
31
-
32
-
### Triggering (and Retriggering) the build
33
-
34
-
- Commit and add this specific tag which `versioneer` will pick up, and push to Github so that CI will build the release artifacts. This is an atomic push so that CI will read the tag on the commit:
33
+
- Create a tag for Github release
35
34
+`git tag vX.Y.Z`
36
35
+`git push --atomic origin release-X.Y.Z vX.Y.Z`
37
36
- Create a Github pull request from `release-X.Y.Z` to `master` and wait for CI to be green
38
-
-*If something goes wrong below*, you'll need to trigger the build process again after a fix. You'll need to commit your changes in the release branch, move the tag and atomically force push:
The `full_build` job in the `release_build` workflow in CircleCI produces a tarball of artifacts `output.tgz` which you should download and decompress, which will give you a directory called `output`. The filenames contained within will contain version numbers.
46
41
47
-
**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.)
48
-
49
42
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`):
50
43
51
44
-`tar xzf output.tgz`
@@ -55,8 +48,6 @@ To locally install the PyPI dist, make sure you have an environment with Jupyter
55
48
56
49
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.
57
50
58
-
If something is broken, you'll need to fix it and trigger the build again (see above section).
59
-
60
51
### Publishing
61
52
62
53
Once you're satisfied that things render in Lab and Notebook in Widget and regular mode,
@@ -65,7 +56,7 @@ you can publish the artifacts. **You will need special credentials from Plotly l
0 commit comments