Skip to content

Commit

Permalink
bump-my-version and release fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
pacrob committed Jan 21, 2025
1 parent a128000 commit 08bba0b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
Expand Down

0 comments on commit 08bba0b

Please sign in to comment.