Skip to content

Commit

Permalink
release info added and version changed
Browse files Browse the repository at this point in the history
  • Loading branch information
dkazanc committed Oct 2, 2024
1 parent 899bce7 commit 7f9d963
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
9 changes: 5 additions & 4 deletions RELEASE_howto.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
HTTomo-backends release how-to
------------------------------

In order to update templates on the documentation page and build the `httomo-backends` PyPi package (with the updated templates) one need to do the following:
In order to update the yaml templates on the documentation page and build the `httomo-backends` PyPi package (with the updated templates) one need to do the steps bellow:

* update version of `httomo-backends`` in the `pyproject.toml` file
* update version of `httomo-backends`` in the `pyproject.toml` file. Change it respectively to changes in the libraries as well as httomo. For example, if it is a simple update of parameters of the existing methods in libraries change the micro version, if a new method added to libraries change the minor version and if there were significant, possibly backward incompatible, changes in httomo and supporting scripts, then change the major version.

* If one needs to update TomoPy's templates then update the version of `tomopy` in `./docs/source/doc-conda-requirements.yml`

* The same applies for the PyPi build, update `tomopy` version there if needed.
* The same applies for the PyPi build, update the `tomopy` version in `/.github/workflows/httomo_backends_pypi_publish.yml`, if needed.

* Tag the `main` branch and make a release to trigger the PyPi build.

Note that there is usually no need to update `httomolib` and `httomolibgpu` versions anywhere as by default pip installed versions will be the latest.
Please note that there might be no need to update `httomolib` and `httomolibgpu` versions as by default the pip installed versions will be the latest.



2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ dev_template = "{tag}"

[project]
name = "httomo-backends"
version = "2.1.2"
version = "0.0.1"
description = "Supplementary files for HTTomo backends."
readme = "README.rst"
license = {text = "BSD-3-Clause"}
Expand Down

0 comments on commit 7f9d963

Please sign in to comment.