search

OPM / pyopmspe11

A Python framework using OPM Flow for the SPE11 benchmark project
http://OPM.github.io/pyopmspe11/
MIT License
8 stars 10 forks source link

Versioning with tags #86

Open MatthewFlamm opened 2 hours ago

MatthewFlamm commented 2 hours ago

This project would be more usable for downstream users if there are versions with tags and/or releases. Currently installation is done through a commit ref on the git repository, either local or remote. This makes it hard to do version control for downstream users. Most users will want to use a versioned release rather than the bleeding edge, which is typically less stable.

Right now the version is hard coded here for the package

https://github.com/OPM/pyopmspe11/blob/17233487c19ced039476e5da427a4b93b72aaf8a/pyproject.toml#L12

and many commits have the same version.

Related to https://github.com/openjournals/joss-reviews/issues/7357

MatthewFlamm commented 2 hours ago

An example, is to use setuptools_scm, which will auto-version your package for each commit based on whether there is a tag or not. I want to make explicit here that there are many ways to do this, setuptools_scm is just one such way.