From 08bba0b5f50cc43e8c36609b86b2ee1553241e5e Mon Sep 17 00:00:00 2001 From: pacrob <5199899+pacrob@users.noreply.github.com> Date: Tue, 21 Jan 2025 12:47:18 -0700 Subject: [PATCH] bump-my-version and release fixes --- Makefile | 2 +- README.md | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 597c0b1..def26cc 100644 --- a/Makefile +++ b/Makefile @@ -34,7 +34,7 @@ CURRENT_SIGN_SETTING := $(shell git config commit.gpgSign) .PHONY: bump-my-version bump-my-version: git config commit.gpgSign true - bump-my-version $(bump) + bump-my-version bump $(bump) git config commit.gpgSign "$(CURRENT_SIGN_SETTING)" git push upstream && git push upstream --tags diff --git a/README.md b/README.md index 4adaf34..63a0160 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,11 @@ To build and publish a release, follow these steps: ### Bump the version First, bump the package version with the included make target: + ```bash -make bumpversion bump=patch +make bump-my-version bump=patch ``` + The above invocation bumps the "patch" version of a semantic version number ("x" in "1.2.x"). Other valid version types are "major" and "minor". The version is bumped by modifying source files that contain the version number, @@ -22,16 +24,16 @@ upstream repository. ### Building & Releasing Packages are build and distributed via Github Actions as soon as a tag is -pushed to the remote repository which is taken care of by the bumpversion command. +pushed to the remote repository which is taken care of by the bump-my-version command. ### Developing You'll need to have [Maturin](https://pyo3.rs/v0.16.4/) installed on your machine. Create a virtual environment, and then you can do: -```sh -$ pip install maturin -$ maturin develop +```bash +pip install maturin +maturin develop ``` to install the dependencies. You may need to specify the