Skip to content

Commit 3da153f

Browse files
authored
Merge pull request #5372 from plotly/release-instructions-cleanup
Lowercase plotly.py and plotly.js in RELEASE.md (follow-up to #5364)
2 parents bf29422 + 2651b21 commit 3da153f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

RELEASE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## Release process - full release of `plotly` package
55

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.
77

88
### Finalize changelog
99

@@ -13,10 +13,10 @@ Make sure the changelog includes the version being published at the top, along
1313
with the expected publication date.
1414

1515
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
1717
been updated, include this as the first `Updated` entry. Call out any
1818
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.
2020

2121
### Update version numbers
2222

@@ -64,7 +64,7 @@ that `go.Figure()` and `go.FigureWidget()` work as expected.
6464
Notes:
6565
- **Start by creating a brand new notebook each time** so that there is no caching of previous results
6666
- **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
6868
6969
Code for testing `go.Figure()`:
7070
```python
@@ -110,7 +110,7 @@ Publishing to PyPI:
110110
```
111111

112112
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.
114114

115115
### Update documentation site
116116

@@ -121,9 +121,9 @@ Your account must have permissions to publish to the Plotly project on PyPI.
121121
start by doing it first if not. Then merge `main` into `doc-prod` to deploy the doc related
122122
to features in the release.
123123
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.
127127
3. rebuild the Algolia `schema` index with `ALGOLIA_API_KEY=<key> make update_ref_search`
128128
4. Rebuild the Algolia `python` index with `ALGOLIA_API_KEY=<key> make update_python_search`
129129
5. Commit and push the changes to `master` in that repo

0 commit comments

Comments
 (0)