From a08971af8be1405c91429cf52e4c3301ffd50945 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Tue, 11 Aug 2020 17:13:22 +0200 Subject: Next release + version creation improvement --- .../for_maintainers/new_gudhi_version_creation.md | 41 ++++++++++++++++++- .github/next_release.md | 47 +++++----------------- 2 files changed, 49 insertions(+), 39 deletions(-) (limited to '.github') diff --git a/.github/for_maintainers/new_gudhi_version_creation.md b/.github/for_maintainers/new_gudhi_version_creation.md index 0dcb25fe..4de81b8a 100644 --- a/.github/for_maintainers/new_gudhi_version_creation.md +++ b/.github/for_maintainers/new_gudhi_version_creation.md @@ -88,8 +88,47 @@ ln -s @GUDHI_VERSION@ latest * Tick the *This is a pre-release* check button if this is a release candidate (untick if this is an official version) * Click the *Publish the release* button +## Pip package + +The pip package construction shall be started on release creation, you just have to check [gudhi github actions](https://github.com/GUDHI/gudhi-devel/actions) results. +The version number must be conform to [pep440](https://www.python.org/dev/peps/pep-0440/#pre-releases) + +## Conda package + +You have to fork [conda-forge/gudhi-feedstock](https://github.com/conda-forge/gudhi-feedstock). +The main changes consist into changing in the `recipe/meta.yaml`: +* `{% set version = "@GUDHI_VERSION@" %}` +* The cgal-cpp version number with the last one (you can find it [here](https://anaconda.org/conda-forge/cgal-cpp)) in the `host:` and the `run:` sections + +Create a Pull Request (PR) from this fork. +If you need to update conda tools (conda-build, conda-smithy, ...), add a comment in your PR saying `@conda-forge-admin, please rerender`, it will done automatically (do not forget to `git pull` the changes). + +## Docker image + +You have to modify the `Dockerfile_gudhi_installation` at the root of this repository in order to use the last release, cf. lines: +``` +... +RUN curl -LO "https://github.com/GUDHI/gudhi-devel/releases/download/tags%2Fgudhi-release-@GUDHI_VERSION@/gudhi.@GUDHI_VERSION@.tar.gz" \ +&& tar xf gudhi.@GUDHI_VERSION@.tar.gz \ +&& cd gudhi.@GUDHI_VERSION@ \ +... +``` + +Build and push images to docker hub: +``` +docker build -f Dockerfile_gudhi_installation -t gudhi/latest_gudhi_version:@GUDHI_VERSION@ . +docker run --rm -it gudhi/latest_gudhi_version:@GUDHI_VERSION@ +``` + +***[Check there are no error with utils and python version]*** + +``` +docker tag gudhi/latest_gudhi_version:@GUDHI_VERSION@ gudhi/latest_gudhi_version:latest +docker push gudhi/latest_gudhi_version:latest +docker push gudhi/latest_gudhi_version:@GUDHI_VERSION@ +``` + ## Mail sending Send version mail to the following lists : * gudhi-devel@lists.gforge.inria.fr * gudhi-users@lists.gforge.inria.fr (not for release candidate) - diff --git a/.github/next_release.md b/.github/next_release.md index 14546066..cd2376eb 100644 --- a/.github/next_release.md +++ b/.github/next_release.md @@ -1,47 +1,19 @@ -We are pleased to announce the release 3.3.0 of the GUDHI library. +We are pleased to announce the release 3.4.0 of the GUDHI library. -As a major new feature, the GUDHI library now offers a persistence-based clustering algorithm, weighted Rips complex using DTM -and edge collapse. +As a major new feature, the GUDHI library now offers ... -The GUDHI library is hosted on GitHub, do not hesitate to [fork the GUDHI project on GitHub](https://github.com/GUDHI/gudhi-devel). -From a user point of view, we recommend to download GUDHI user version (gudhi.3.3.0.tar.gz). +We are now using GitHub to develop the GUDHI library, do not hesitate to [fork the GUDHI project on GitHub](https://github.com/GUDHI/gudhi-devel). From a user point of view, we recommend to download GUDHI user version (gudhi.3.4.0.tar.gz). -Below is a list of changes made since GUDHI 3.2.0: +Below is a list of changes made since GUDHI 3.3.0: -- [DTM density estimator](https://gudhi.inria.fr/python/latest/point_cloud.html#module-gudhi.point_cloud.dtm) - - Python implementation of a density estimator based on the distance to the empirical measure defined by a point set. +- [Module](link) + - ... -- [DTM Rips complex](https://gudhi.inria.fr/python/latest/rips_complex_user.html#dtm-rips-complex) - - This Python implementation constructs a weighted Rips complex giving larger weights to outliers, - which reduces their impact on the persistence diagram - -- [Alpha complex](https://gudhi.inria.fr/python/latest/alpha_complex_user.html) - Python interface improvements - - 'fast' and 'exact' computations - - Delaunay complex construction by not setting filtration values - - Use the specific 3d alpha complex automatically to make the computations faster - -- [Clustering](https://gudhi.inria.fr/python/latest/clustering.html) - - Python implementation of [ToMATo](https://doi.org/10.1145/2535927), a persistence-based clustering algorithm - -- [Edge Collapse](https://gudhi.inria.fr/doc/latest/group__edge__collapse.html) of a filtered flag complex - - This C++ implementation reduces a filtration of Vietoris-Rips complex from its graph to another smaller - flag filtration with the same persistence. - -- [Bottleneck distance](https://gudhi.inria.fr/python/latest/bottleneck_distance_user.html) - - Python interface to [hera](https://github.com/grey-narn/hera)'s bottleneck distance - -- Persistence representations - - [Atol](https://gudhi.inria.fr/python/latest/representations.html#gudhi.representations.vector_methods.Atol) - is integrated in finite vectorisation methods. This - [article](https://www.fujitsu.com/global/about/resources/news/press-releases/2020/0316-01.html) talks about - applications using Atol. This module was originally available at - [https://github.com/martinroyer/atol](https://github.com/martinroyer/atol) - - Python interface change: [Wasserstein metrics](https://gudhi.inria.fr/python/latest/representations.html#gudhi.representations.metrics.WassersteinDistance) - is now [hera](https://github.com/grey-narn/hera) by default +- [Module](link) + - ... - Miscellaneous - - The [list of bugs that were solved since GUDHI-3.2.0](https://github.com/GUDHI/gudhi-devel/issues?q=label%3A3.3.0+is%3Aclosed) - is available on GitHub. + - The [list of bugs that were solved since GUDHI-3.3.0](https://github.com/GUDHI/gudhi-devel/issues?q=label%3A3.4.0+is%3Aclosed) is available on GitHub. All modules are distributed under the terms of the MIT license. However, there are still GPL dependencies for many modules. We invite you to check our [license dedicated web page](https://gudhi.inria.fr/licensing/) for further details. @@ -53,4 +25,3 @@ We provide [bibtex entries](https://gudhi.inria.fr/doc/latest/_citation.html) fo Feel free to [contact us](https://gudhi.inria.fr/contact/) in case you have any questions or remarks. For further information about downloading and installing the library ([C++](https://gudhi.inria.fr/doc/latest/installation.html) or [Python](https://gudhi.inria.fr/python/latest/installation.html)), please visit the [GUDHI web site](https://gudhi.inria.fr/). - -- cgit v1.2.3