Skip to content

Commit

Permalink
readme: Add release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jorisv committed Nov 5, 2024
1 parent 443ed01 commit f8faf38
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,24 @@ pixi run test
The project will be built in the `build` directory.
You can run `pixi shell` and build the project with `cmake` and `ninja` manually.

## Release with Pixi

To create a release with Pixi run the following commands on the **devel** branch:

```bash
PINOCCHIO_VERSION=X.Y.Z pixi run release_new_version
git push origin
git push origin vX.Y.Z
git push origin devel:master
```

Where `X.Y.Z` is the new version.
Be careful to follow the [Semantic Versioning](https://semver.org/spec/v2.0.0.html) rules.

You will find the following assets to upload to GitHub:
- `./build_new_version/pinocchio-X.Y.Z.tar.gz`
- `./build_new_version/pinocchio-X.Y.Z.tar.gz.sig`

## Visualization

**Pinocchio** provides support for many open-source and free visualizers:
Expand Down

0 comments on commit f8faf38

Please sign in to comment.