Merge pull request #515 from jorisv/topic/new_version_task

Add a task to easily release a new EigenPy version

Author: jcarpent

.gitignore

@@ -1,4 +1,4 @@
 *~
-*build*
+*build*/
 # pixi environments
 .pixi

README.md

@@ -29,7 +29,7 @@ EigenPy — Versatile and efficient Python bindings between Numpy and Eigen
 
 The installation of **EigenPy** on your computer is made easy for Linux/BSD, Mac OS X, and Windows environments.
 
-### The Conda approach
+### Conda
 
 You simply need this simple line:
 ```bash
@@ -41,6 +41,7 @@ conda install eigenpy -c conda-forge
 You can easily install **EigenPy** from binaries.
 
 #### Add robotpkg apt repository
+
 1. Add robotpkg as source repository to apt:
 ```
 sudo sh -c "echo 'deb [arch=amd64] http://robotpkg.openrobots.org/packages/debian/pub $(lsb_release -cs) robotpkg' >> /etc/apt/sources.list.d/robotpkg.list"
@@ -55,6 +56,7 @@ sudo apt-get update
 ```
 
 #### Install EigenPy
+
 4. The installation of **EigenPy** and its dependencies is made through the line:
 
 ```bash
@@ -75,26 +77,9 @@ and then install **EigenPy** for Python 3.x with:
 brew install eigenpy
 ```
 
-## Contributing
-
-Standard matrix decomposion routines of Eigen such as the SVD and QR decompositions can be readily added to **EigenPy** following the example of the Cholesky decomposition that is already implemented. Feel free to open a PR if you wrap them for your use case.
-
-## Build/install from source with Pixi
-
-To build **EigenPy** from source the easiest way is to use [Pixi](https://pixi.sh/latest/#installation).
-
-[Pixi](https://pixi.sh/latest/) is a cross-platform package management tool for developers that
-will install all required dependencies in `.pixi` directory.
-It's used by our CI agent so you have the guarantee to get the right dependencies.
-
-Run the following command to install dependencies, configure, build and test the project:
-
-```bash
-pixi run test
-```
+## Build
 
-The project will be built in the `build` directory.
-You can run `pixi shell` and build the project with `cmake` and `ninja` manually.
+Build instruction can be found [here](./development/build.md)
 
 ## Credits
 

cmake

@@ -0,0 +1,17 @@
+# Build and install from source with Pixi
+
+To build **EigenPy** from source the easiest way is to use [Pixi](https://pixi.sh/latest/#installation).
+
+[Pixi](https://pixi.sh/latest/) is a cross-platform package management tool for developers that
+will install all required dependencies in `.pixi` directory.
+It's used by our CI agent so you have the guarantee to get the right dependencies.
+
+Run the following command to install dependencies, configure, build and test the project:
+
+```bash
+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.
+

development/build.md

@@ -0,0 +1,7 @@
+# Contributing
+
+Standard matrix decomposion routines of Eigen such as the SVD and QR decompositions
+can be readily added to **EigenPy** following the example of the Cholesky decomposition
+that is already implemented.
+Feel free to open a PR if you wrap them for your use case.
+

development/contributing.md

@@ -0,0 +1,34 @@
+# Release with Pixi
+
+To create a release with Pixi run the following commands on the **devel** branch:
+
+```bash
+EIGENPY_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:
+- `./build_new_version/eigenpy-X.Y.Z.tar.gz`
+- `./build_new_version/eigenpy-X.Y.Z.tar.gz.sig`
+
+Then, create a new release on [GitHub](https://github.com/stack-of-tasks/eigenpy/releases/new) with:
+
+* Tag: vX.Y.Z
+* Title: EigenPy X.Y.Z
+* Body:
+```
+## What's Changed
+
+CHANGELOG CONTENT
+
+**Full Changelog**: https://github.com/stack-of-tasks/eigenpy/compare/vXX.YY.ZZ...vX.Y.Z
+```
+
+Where `XX.YY.ZZ` is the last release version.
+
+Then upload `eigenpy-X.Y.Z.tar.gz` and `eigenpy-X.Y.Z.tar.gz.sig` and publish the release.

development/release.md

@@ -24,10 +24,10 @@ python = ">=3.9.0"
 scipy = ">=1.10.0"
 
 [activation]
-scripts = ["build_scripts/pixi/activation.sh"]
+scripts = ["development/scripts//pixi/activation.sh"]
 
 [target.win-64.activation]
-scripts = ["build_scripts/pixi/activation.bat"]
+scripts = ["development/scripts//pixi/activation.bat"]
 
 [tasks]
 # We must avoid to set CMAKE_CXX_FLAGS because of WIN32
@@ -57,6 +57,30 @@ test = { cmd = "ctest --test-dir build --output-on-failure", depends_on = [
 dependencies = { pre-commit = ">=3.6.2" }
 tasks = { lint = { cmd = "pre-commit run --all" } }
 
+# Increment the version number with EIGENPY_VERSION variable
+[feature.new-version.dependencies]
+tomlkit = ">=0.13.2"
+
+[feature.new-version.tasks]
+configure_new_version = { cmd = [
+  "CXXFLAGS=$EIGENPY_CXX_FLAGS",
+  "cmake",
+  "-G",
+  "Ninja",
+  "-B",
+  "build_new_version",
+  "-S",
+  ".",
+  "-DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX",
+  "-DCMAKE_BUILD_TYPE=$EIGENPY_BUILD_TYPE",
+  "-DGENERATE_PYTHON_STUBS=ON",
+  "-DBUILD_WITH_CHOLMOD_SUPPORT=ON",
+  "-DBUILD_WITH_ACCELERATE_SUPPORT=OFF",
+] }
+release_new_version = { cmd = "VERSION=$EIGENPY_VERSION cmake --build build_new_version --target release", depends-on = [
+  "configure_new_version",
+] }
+
 # Cholmod support
 [feature.cholmod]
 dependencies = { suitesparse = ">=5" }
@@ -78,14 +102,14 @@ python = "3.9.*"
 # to avoid cxx-compiler to overwrite them.
 [feature.clang-cl]
 platforms = ["win-64"]
-activation = { scripts = ["build_scripts/pixi/activation_clang_cl.bat"] }
+activation = { scripts = ["development/scripts//pixi/activation_clang_cl.bat"] }
 
 # Use clang on GNU/Linux.
 # We must use scripts instead of env to setup CC and CXX
 # to avoid cxx-compiler to overwrite them.
 [feature.clang]
 platforms = ["linux-64"]
-activation = { scripts = ["build_scripts/pixi/activation_clang.sh"] }
+activation = { scripts = ["development/scripts//pixi/activation_clang.sh"] }
 dependencies = { clangxx = "*" }
 
 [environments]
@@ -103,3 +127,9 @@ all-clang-cl = { features = [
   "clang-cl",
   "py312",
 ], solve-group = "py312" }
+# Release a new software version
+new-version = { features = [
+  "new-version",
+  "cholmod",
+  "py312",
+], solve-group = "py312" }