add bumpversion script in commands.py for updating version numbers

Author: emilykl

RELEASE.md

@@ -7,10 +7,11 @@ This is the release process for releasing plotly.py version `X.Y.Z`, including c
 
 ### Finalize changelog
 
-Review the contents of `CHANGELOG.md`. We try to follow
+Review the contents of `CHANGELOG.md` under the **Unreleased** header. We try to follow
 the [keepachangelog](https://keepachangelog.com/en/1.0.0/) guidelines.
-Make sure the changelog includes the version being published at the top, along
-with the expected publication date.
+
+**Note: You don't need to update the header itself 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`
 labels for all changes to plotly.py.  If the version of plotly.js has
@@ -22,18 +23,24 @@ a link to the plotly.js CHANGELOG.
 
 **Create a release branch `git checkout -b release-X.Y.Z` _from the tip of `origin/main`_.**
 
-- Manually update the versions to `X.Y.Z` in the files specified below:
+- Ensure that you have `npm` and `uv` installed in your environment
+
+- Run the command `python commands.py bumpversion X.Y.Z`, which will update the version to X.Y.Z in the following places
   - `pyproject.toml`
-    - update version
+  - `uv.lock`
   - `js/package.json`
-    - update version (`"version"` key at top of file)
-  - `CHANGELOG.md`
-    - update version and release date
-    - finalize changelog entries according to instructions above
+  - `js/package-lock.json`
+  - `CHANGELOG.md` (Adds a new header for X.Y.Z above the unreleased items)
   - `CITATION.cff`
-    - update version and release date
-- Run `uv lock` to update the version number in the `uv.lock` file (do not update manually)
-- Commit and push your changes to the release branch:
+
+- Run `git diff` and ensure the above files were all updated correctly.
+  - Note: The current date is used as the release date in `CHANGELOG.md` and `CITATION.cff`. If you want to use a different date, edit these files manually afterward.
+  - If the bumpversion command failed for any reason, you can update the versions yourself by doing the following:
+    - Manually update the version number (and release date, as needed) in `pyproject.toml`, `CHANGELOG.md` and `CITATION.cff`
+    - Run `npm version X.Y.Z` to update `js/package.json` and `js/package-lock.json`
+    - Run `uv lock` to update `uv.lock`
+
+- Commit and push the changed files to the release branch:
     ```sh
     $ git add -u
     $ git commit -m "version changes for vX.Y.Z"

commands.py

@@ -5,8 +5,10 @@
 import json
 import os
 import platform
+import re
 import requests
 import shutil
+import subprocess
 from subprocess import check_call
 import sys
 import time
@@ -296,6 +298,102 @@ def update_plotlyjs_dev(args, outdir):
     perform_codegen(outdir)
 
 
+def bump_version_pyproject_toml(new_version):
+    """Bump the version in pyproject.toml to new_version"""
+
+    pyproject_toml_path = "pyproject.toml"
+    pattern = r'(^\s*version\s*=\s*")([\w.]+)"(\s*$)'
+    with open(pyproject_toml_path, "r") as f:
+        content = f.read()
+    new_content = re.sub(
+        pattern,
+        rf'\g<1>{new_version}"\g<3>',
+        content,
+        count=1,  # replace only the first match
+        flags=re.MULTILINE,
+    )
+    with open(pyproject_toml_path, "w") as f:
+        f.write(new_content)
+    
+    # Run `uv lock` to update the version number in the `uv.lock` file (do not update manually)
+    subprocess.run(["uv", "lock"], check=True)
+
+    print(f"Updated version in {pyproject_toml_path} to {new_version}, and updated uv lockfile")
+
+
+def bump_version_package_json(new_version):
+    """Bump the version in package.json to new_version"""
+    js_dir = "js"
+    subprocess.run(
+        ["npm", "version", new_version, "--no-git-tag-version", "--allow-same-version"],
+        cwd=js_dir,
+        check=True,
+    )
+    print(
+        f"Updated version in {js_dir}/package.json and {js_dir}/package-lock.json to {new_version}"
+    )
+
+
+def bump_version_citation_cff(new_version, new_date):
+    """Bump the version in CITATION.cff to new_version and date-released to new_date"""
+    citation_cff_path = "CITATION.cff"
+    pattern_version = r'(^\s*version\s*:\s*)([\w.]+)(\s*$)'
+    pattern_date = r'(^\s*date-released\s*:\s*)([0-9\-]+)(\s*$)'
+
+    with open(citation_cff_path, "r") as f:
+        content = f.read()
+    new_content = re.sub(
+        pattern_version,
+        rf'\g<1>{new_version}\g<3>',
+        content,
+        count=1,  # replace only the first match
+        flags=re.MULTILINE,
+    )
+    new_content = re.sub(
+        pattern_date,
+        rf'\g<1>{new_date}\g<3>',
+        new_content,
+        count=1,  # replace only the first match
+        flags=re.MULTILINE,
+    )
+    with open(citation_cff_path, "w") as f:
+        f.write(new_content)
+    print(
+        f"Updated version in {citation_cff_path} to {new_version} and date-released to {new_date}"
+    )
+
+def bump_version_changelog_md(new_version, new_date):
+    """Bump the version in CHANGELOG.md to new_version and date to new_date"""
+    changelog_md_path = "CHANGELOG.md"
+    pattern = r'(^\s*##\s*Unreleased\s*$)'
+    new_header = f"\n\n## [{new_version}] - {new_date}\n"
+    with open(changelog_md_path, "r") as f:
+        content = f.read()
+    new_content = re.sub(
+        pattern,
+        rf'\g<1>{new_header}',
+        content,
+        count=1,  # replace only the first match
+        flags=re.MULTILINE,
+    )
+    with open(changelog_md_path, "w") as f:
+        f.write(new_content)
+    print(f"Updated version in {changelog_md_path} to {new_version}")
+
+
+def bump_version(args):
+    """Bump the version of plotly.py everywhere it needs to be updated."""
+    new_version = args.version
+    new_date = time.strftime("%Y-%m-%d")
+
+    # bump_version_citation_cff(new_version, new_date)
+    # bump_version_changelog_md(new_version, new_date)
+    # bump_version_package_json(new_version)
+    # Do this one last since it's the most visible,
+    # so that if one of the above commands fails it will be easier to notice
+    bump_version_pyproject_toml(new_version)
+
+
 def make_parser():
     """Make argument parser."""
 
@@ -322,6 +420,10 @@ def make_parser():
 
     subparsers.add_parser("updateplotlyjs", help="update plotly.js")
 
+    p_bump_version = subparsers.add_parser("bumpversion", help="bump plotly.py version")
+    # Add a positional argument for the version
+    p_bump_version.add_argument("version", help="version number")
+
     return parser
 
 
@@ -356,6 +458,9 @@ def main():
         print(version)
         update_plotlyjs(version, outdir)
 
+    elif args.cmd == "bumpversion":
+        bump_version(args)
+
     elif args.cmd is None:
         parser.print_help()
         sys.exit(1)