Skip to content

Commit bcebc1c

Browse files
committed
update release documentation
1 parent edd84a7 commit bcebc1c

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

RELEASE.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,27 @@
55

66
This is the release process for releasing plotly.py version `X.Y.Z`, including changelogs, GitHub release and forum announcement.
77

8+
### Prerequisites
9+
10+
Ensure you have the following installed:
11+
12+
* `uv>=0.12.15`
13+
* `twine>=7.0.0`
14+
* A virtual environment: `uv venv`
15+
16+
### Prepare local environment
17+
18+
* `git switch main && git pull`
19+
3. `git status`: ensure your working tree is clean
20+
4. `uv pip install -e ".[dev_optional]"`
21+
5. `cd js && npm ci && cd ..`
22+
823
### Finalize changelog
924

1025
Review the contents of `CHANGELOG.md` under the **Unreleased** header. We try to follow
1126
the [keepachangelog](https://keepachangelog.com/en/1.0.0/) guidelines.
1227

13-
**Note: You don't need to update the header itself with the new version number,
28+
**Note: You don't need to update the "Unreleased" header with the new version number,
1429
as that will be done automatically as part of the next step.**
1530

1631
Use the `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, and `Security`
@@ -44,7 +59,7 @@ a link to the plotly.js CHANGELOG.
4459

4560
- Commit and push the changed files to the release branch:
4661
```sh
47-
$ git add -u
62+
$ git add -A
4863
$ git commit -m "version changes for vX.Y.Z"
4964
$ git push
5065
```
@@ -117,6 +132,7 @@ You must first install [Twine](https://pypi.org/project/twine/) (`pip install tw
117132
Publishing to PyPI:
118133
```bash
119134
(plotly_dev) $ cd path/to/output
135+
(plotly_dev) $ twine check plotly-X.Y.Z*
120136
(plotly_dev) $ twine upload plotly-X.Y.Z*
121137
```
122138

0 commit comments

Comments
 (0)