feat: add release command (#687)

Author: adhtruong

.github/workflows/docs.yml

@@ -19,11 +19,6 @@ jobs:
         with:
           python-version: "3.13"
 
-      - name: Set up python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
       - name: Install uv
         uses: astral-sh/setup-uv@v5
         with:

CONTRIBUTING.rst

@@ -76,9 +76,9 @@ restructure the docs etc., but make sure to follow these guidelines:
 Creating a new release
 ----------------------
 
-1. Increment the version in ``pyproject.toml``
+1. Run `make release` to bump version and commit.
     .. note:: The version should follow `semantic versioning <https://semver.org/>`_ and `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.
-2. Commit and push.
+2. Push and create PR.
 3. In GitHub go to the `releases tab <https://github.com/litestar-org/polyfactory/releases>`_
 4. Pick "`Draft a new release <https://github.com/litestar-org/polyfactory/releases/new>`_"
 5. Give it a title and a tag, both ``vX.X.X``

Makefile

@@ -53,6 +53,10 @@ destroy: 											## Destroy the virtual environment
 lock:                                             ## Rebuild lockfiles from scratch, updating all dependencies
 	@uv lock
 
+.PHONY: release
+release:
+	./tools/prepare-release.sh
+
 # =============================================================================
 # Tests, Linting, Coverage
 # =============================================================================
@@ -107,7 +111,3 @@ docs-serve: docs-clean 								## Serve the docs locally
 docs: docs-clean 									## Dump the existing built docs and rebuild them
 	@echo "=> Building documentation"
 	@uv run sphinx-build -M html docs docs/_build/ -E -a -j auto --keep-going
-
-changelog:
-	@echo "=> Generating changelog"
-	@uv run git-cliff -c pyproject.toml -o docs/changelog.rst --github-repo litestar-org/polyfactory --github-token $(GITHUB_TOKEN)

pyproject.toml

@@ -108,6 +108,25 @@ dev = [
   "sqlalchemy[asyncio]>=1.4.29",
 ]
 
+[tool.bumpversion]
+allow_dirty = true
+commit = true
+commit_args = "--no-verify"
+current_version = "2.20.0"
+ignore_missing_files = false
+ignore_missing_version = false
+message = "chore(release): bump to v{new_version}"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+regex = false
+replace = "{new_version}"
+search = "{current_version}"
+serialize = ["{major}.{minor}.{patch}"]
+sign_tags = false
+tag = false
+tag_message = "chore(release): v{new_version}"
+tag_name = "v{new_version}"
+pre_commit_hooks = ["uv sync", "git add uv.lock docs/changelog.rst"]
+
 [tool.mypy]
 exclude = "^tools/.*"
 plugins = ["pydantic.mypy"]

tools/prepare-release.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -e
+
+bumped_version=$(
+	uv run git-cliff \
+		-c pyproject.toml \
+		--github-token "$(gh auth token)" \
+		--bumped-version
+)
+
+uv run git-cliff \
+	-c pyproject.toml \
+	--github-token "$(gh auth token)" \
+	--tag "$bumped_version" \
+	--output docs/changelog.rst
+
+uvx bump-my-version@1.1.2 bump --new-version "$bumped_version"