Home

Jump to bottom

Sarthak Pati edited this page Feb 8, 2024 · 7 revisions

Welcome to the GaNDLF wiki!

Start

Full documentation: https://gandlf.org/
If you are moving from the older CBICA repository, please follow this guide to rebase your current fork.

New releases and making version updates

The version file should have the latest development version information. As far as possible, GaNDLF follows Semantic Versioning.
Update the version file to remove "-dev" from the __version__ variable, and change to whatever number the version needs to be tagged to.
Create a new release of the main development branch using the new number referred to in the __version__ variable.

Give a meaningful title.
Use the option "Generate release notes" on GitHub.
Select appropriate options.
Publish.

Update the version file to add "-dev" in the __version__ variable, and increase the version number as appropriate. This will be used for nightly publishing of development builds. Ensure that the new version is also updated in all sample configurations and in the testing configurations so that unit tests will pass.

For simplicity, one can use the gandlf_updateVersion script.