Skip to content

Commit

Permalink
chore(docs): updated release process (#55)
Browse files Browse the repository at this point in the history
* chore: update release guide

* fix: typo
  • Loading branch information
cofin authored Nov 30, 2024
1 parent 0a7262d commit 5b8bba1
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 89 deletions.
14 changes: 8 additions & 6 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,15 @@ Then you can serve the documentation with ``make docs-serve``, or build them wit
Creating a new release
----------------------

1. Increment the version in `pyproject.toml <https://github.com/litestar-org/litestar-vite/blob/main/pyproject.toml>`_.
1. Ensure that all local changes are committed and your commit tree is not dirty
2. Run ``make release bump=major|minor|patch`` to bump the version for the python and javascript packages. This will automatically update the version and create a commit.
.. note:: The version should follow `semantic versioning <https://semver.org/>`_ and `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.
2. `Draft a new release <https://github.com/litestar-org/litestar-vite/releases/new>`_ on GitHub
3. Push the changes to the ``main`` branch
4. `Draft a new release <https://github.com/litestar-org/litestar-vite/releases/new>`_ on GitHub

* Use ``vMAJOR.MINOR.PATCH`` (e.g. ``v1.2.3``) as both the tag and release title
* Fill in the release description. You can use the "Generate release notes" function to get a draft for this
3. Commit your changes and push to ``main``
4. Publish the release
5. Go to `Actions <https://github.com/litestar-org/litestar-vite/actions>`_ and approve the release workflow
6. Check that the workflow runs successfully

5. Publish the release
6. Go to `Actions <https://github.com/litestar-org/litestar-vite/actions>`_ and approve the release workflow
7. Check that the workflow runs successfully
7 changes: 4 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ SHELL := /bin/bash
help: ## Display this help text for Makefile
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

.PHONY: pre-release
pre-release: ## bump the version and create the release tag
.PHONY: release
release: ## bump the version and create the release tag
make docs
make clean
make build
uv run bump-my-version bump $(increment)
uv run bump-my-version bump $(bump)
uv lock --upgrade-package litestar-vite

# =============================================================================
# Developer Utils
Expand Down
150 changes: 75 additions & 75 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -82,21 +82,21 @@ test = [
]

[tool.bumpversion]
allow_dirty = true
commit = false
allow_dirty = false
commit = true
commit_args = "--no-verify"
current_version = "0.7.0"
ignore_missing_files = false
ignore_missing_version = true
message = "chore(release): prepare for v{new_version}"
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): prepare for v{new_version}"
tag_message = "chore(release): v{new_version}"
tag_name = "v{new_version}"

[[tool.bumpversion.files]]
Expand Down

0 comments on commit 5b8bba1

Please sign in to comment.