Skip to content

Commit bcfa6a7

Browse files
committed
Update release instructions
1 parent 69897ae commit bcfa6a7

File tree

2 files changed

+4
-14
lines changed

2 files changed

+4
-14
lines changed

.gitattributes

Lines changed: 0 additions & 1 deletion
This file was deleted.

release.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,28 +24,21 @@ a link to the plotly.js CHANGELOG.
2424

2525
Manually update the versions to `X.Y.Z` in the files specified below.
2626

27+
- `pyproject.toml`
28+
+ update version
2729
- `CHANGELOG.md`
2830
+ update the release date
2931
- Commit your changes on the branch:
3032
+ `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
3534
+ `git tag vX.Y.Z`
3635
+ `git push --atomic origin release-X.Y.Z vX.Y.Z`
3736
- 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:
39-
+ `git commit ....`
40-
+ `git tag -f vX.Y.Z`
41-
+ `git push --force --atomic origin release-X.Y.Z vX.Y.Z`
4237

4338
### Download and QA CI Artifacts
4439

4540
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.
4641

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-
4942
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`):
5043

5144
- `tar xzf output.tgz`
@@ -55,8 +48,6 @@ To locally install the PyPI dist, make sure you have an environment with Jupyter
5548

5649
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.
5750

58-
If something is broken, you'll need to fix it and trigger the build again (see above section).
59-
6051
### Publishing
6152

6253
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
6556

6657
Publishing to PyPI:
6758
```bash
68-
(plotly_dev) $ cd path/to/output/dist
59+
(plotly_dev) $ cd path/to/output
6960
(plotly_dev) $ twine upload plotly-X.Y.Z*
7061
```
7162

0 commit comments

Comments
 (0)