Skip to content

Commit 4233a3f

Browse files
committed
readme: Add instructions
1 parent 4941dbc commit 4233a3f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,24 @@ pixi run test
9696
The project will be built in the `build` directory.
9797
You can run `pixi shell` and build the project with `cmake` and `ninja` manually.
9898

99+
## Release with Pixi
100+
101+
To create a release with Pixi run the following commands on the **devel** branch:
102+
103+
```bash
104+
EIGENPY_VERSION=X.Y.Z pixi run release_new_version
105+
git push origin
106+
git push origin vX.Y.Z
107+
git push origin devel:master
108+
```
109+
110+
Where `X.Y.Z` is the new version.
111+
Be careful to follow the [Semantic Versioning](https://semver.org/spec/v2.0.0.html) rules.
112+
113+
You will find the following assets to upload to GitHub:
114+
- `./build_new_version/eigenpy-X.Y.Z.tar.gz`
115+
- `./build_new_version/eigenpy-X.Y.Z.tar.gz.sig`
116+
99117
## Credits
100118

101119
The following people have been involved in the development of **EigenPy**:

0 commit comments

Comments
 (0)