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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
4
4
## Release process - full release of `plotly` package
5
5
6
-
This is the release process for releasing Plotly.py version `X.Y.Z`, including changelogs, GitHub release and forum announcement.
6
+
This is the release process for releasing plotly.py version `X.Y.Z`, including changelogs, GitHub release and forum announcement.
7
7
8
8
### Finalize changelog
9
9
@@ -13,10 +13,10 @@ Make sure the changelog includes the version being published at the top, along
13
13
with the expected publication date.
14
14
15
15
Use the `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, and `Security`
16
-
labels for all changes to Plotly.py. If the version of Plotly.js has
16
+
labels for all changes to plotly.py. If the version of plotly.js has
17
17
been updated, include this as the first `Updated` entry. Call out any
18
18
notable changes as sub-bullets (new trace types in particular), and provide
19
-
a link to the Plotly.js CHANGELOG.
19
+
a link to the plotly.js CHANGELOG.
20
20
21
21
### Update version numbers
22
22
@@ -64,7 +64,7 @@ that `go.Figure()` and `go.FigureWidget()` work as expected.
64
64
Notes:
65
65
- **Start by creating a brand new notebook each time** so that there is no caching of previous results
66
66
- **Do not run the Jupyter commands from the root `plotly.py/` directory on your machine** because Jupyter may be confused
67
-
by metadata from previous Plotly.py builds
67
+
by metadata from previous plotly.py builds
68
68
69
69
Code for testing `go.Figure()`:
70
70
```python
@@ -110,7 +110,7 @@ Publishing to PyPI:
110
110
```
111
111
112
112
You will be prompted to enter an API token; this can be generated in your PyPI account settings.
113
-
Your account must have permissions to publish to the Plotly project on PyPI.
113
+
Your account must have permissions to publish to the `plotly` project on PyPI.
114
114
115
115
### Update documentation site
116
116
@@ -121,9 +121,9 @@ Your account must have permissions to publish to the Plotly project on PyPI.
121
121
start by doing it first if not. Then merge `main` into `doc-prod` to deploy the doc related
122
122
to features in the release.
123
123
3. in a clone of the [`graphing-library-docs` repo](https://github.com/plotly/graphing-library-docs):
124
-
1. bump the version of Plotly.py in `_data/pyversion.json`
125
-
2. bump the version of Plotly.js with `cd _data && python get_plotschema.py <PLOTLY.JS VERSION>` fixing any errors that come up.
126
-
- If Plotly.js contains any new traces or trace or layout attributes, you'll get a warning `“missing key in attributes: <attribute-name>`. To resolve, add the attribute to the relevant section in `/_data/orderings.json` in the position you want it to appear in the reference docs.
124
+
1. bump the version of plotly.py in `_data/pyversion.json`
125
+
2. bump the version of plotly.js with `cd _data && python get_plotschema.py <PLOTLY.JS VERSION>` fixing any errors that come up.
126
+
- If plotly.js contains any new traces or trace or layout attributes, you'll get a warning `“missing key in attributes: <attribute-name>`. To resolve, add the attribute to the relevant section in `/_data/orderings.json` in the position you want it to appear in the reference docs.
127
127
3. rebuild the Algolia `schema` index with `ALGOLIA_API_KEY=<key> make update_ref_search`
128
128
4. Rebuild the Algolia `python` index with `ALGOLIA_API_KEY=<key> make update_python_search`
129
129
5. Commit and push the changes to `master` in that repo
0 commit comments