|
5 | 5 |
|
6 | 6 | This is the release process for releasing plotly.py version `X.Y.Z`, including changelogs, GitHub release and forum announcement. |
7 | 7 |
|
| 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 | + |
8 | 23 | ### Finalize changelog |
9 | 24 |
|
10 | 25 | Review the contents of `CHANGELOG.md` under the **Unreleased** header. We try to follow |
11 | 26 | the [keepachangelog](https://keepachangelog.com/en/1.0.0/) guidelines. |
12 | 27 |
|
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, |
14 | 29 | as that will be done automatically as part of the next step.** |
15 | 30 |
|
16 | 31 | Use the `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, and `Security` |
@@ -44,7 +59,7 @@ a link to the plotly.js CHANGELOG. |
44 | 59 |
|
45 | 60 | - Commit and push the changed files to the release branch: |
46 | 61 | ```sh |
47 | | - $ git add -u |
| 62 | + $ git add -A |
48 | 63 | $ git commit -m "version changes for vX.Y.Z" |
49 | 64 | $ git push |
50 | 65 | ``` |
@@ -117,6 +132,7 @@ You must first install [Twine](https://pypi.org/project/twine/) (`pip install tw |
117 | 132 | Publishing to PyPI: |
118 | 133 | ```bash |
119 | 134 | (plotly_dev) $ cd path/to/output |
| 135 | +(plotly_dev) $ twine check plotly-X.Y.Z* |
120 | 136 | (plotly_dev) $ twine upload plotly-X.Y.Z* |
121 | 137 | ``` |
122 | 138 |
|
|
0 commit comments