From bcebc1c79c4817c79eae37ab2c18b516cca291e0 Mon Sep 17 00:00:00 2001 From: Adrian Borrmann Date: Tue, 15 Sep 2026 14:57:23 -0600 Subject: [PATCH 1/2] update release documentation --- RELEASE.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 6e2de6dc6c0..ac766aa19ec 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -5,12 +5,27 @@ This is the release process for releasing plotly.py version `X.Y.Z`, including changelogs, GitHub release and forum announcement. +### Prerequisites + +Ensure you have the following installed: + +* `uv>=0.12.15` +* `twine>=7.0.0` +* A virtual environment: `uv venv` + +### Prepare local environment + +* `git switch main && git pull` +3. `git status`: ensure your working tree is clean +4. `uv pip install -e ".[dev_optional]"` +5. `cd js && npm ci && cd ..` + ### Finalize changelog Review the contents of `CHANGELOG.md` under the **Unreleased** header. We try to follow the [keepachangelog](https://keepachangelog.com/en/1.0.0/) guidelines. -**Note: You don't need to update the header itself with the new version number, +**Note: You don't need to update the "Unreleased" header with the new version number, as that will be done automatically as part of the next step.** Use the `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, and `Security` @@ -44,7 +59,7 @@ a link to the plotly.js CHANGELOG. - Commit and push the changed files to the release branch: ```sh - $ git add -u + $ git add -A $ git commit -m "version changes for vX.Y.Z" $ git push ``` @@ -117,6 +132,7 @@ You must first install [Twine](https://pypi.org/project/twine/) (`pip install tw Publishing to PyPI: ```bash (plotly_dev) $ cd path/to/output +(plotly_dev) $ twine check plotly-X.Y.Z* (plotly_dev) $ twine upload plotly-X.Y.Z* ``` From c4ffc6a1d117a99faa1d7f865c1632d566cbaf6d Mon Sep 17 00:00:00 2001 From: Adrian Borrmann Date: Tue, 15 Sep 2026 15:12:31 -0600 Subject: [PATCH 2/2] fix formatting --- RELEASE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index ac766aa19ec..9939df73416 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -16,9 +16,9 @@ Ensure you have the following installed: ### Prepare local environment * `git switch main && git pull` -3. `git status`: ensure your working tree is clean -4. `uv pip install -e ".[dev_optional]"` -5. `cd js && npm ci && cd ..` +* `git status`: ensure your working tree is clean +* `uv pip install -e ".[dev_optional]"` +* `cd js && npm ci && cd ..` ### Finalize changelog