Good practices for OpenFLUID releases
From OpenFLUID
Contents |
Preliminary checks
OpenFLUID framework and applications, and related documentation
- All modifications are commited
- All tests passes in Debug build mode
- Version number is correct in CMake.in.config
- CHANGELOG file is up-to-date
- Version number is correct in Quick user manual
- All documentation can be built (Quick user manual, API guide, ...)
- All examples can be built (Quick user manual, API guide, ...)
Eclipse plugin for new function wizard
- Version number is correct
- Generated simulations functions builds and works correctly with current OpenFLUID framework and applications
Bindings
ROpenFLUID
- Version number is correct
- The package is checked and builds correctly
- Man pages are up-to-date
Models
- Simulation functions of provides models (MHYDAS) are adapted, build and works perfectly
Community wiki
- Documentation page is up to date with latest available documents
- "Upgrading to a new version" page is up to date with correct instructions
Building and packaging
- OpenFLUID framework and applications :
- If the release is a final release, create a branch from trunk named release-<version number> (eg. release-1.6.2). Building and packaging will be done using this branch.
- Build and create packages in Release mode (see How to build OpenFLUID) for the following platforms:
- linux 32bits
- linux 64bits
- win 32bits
- source code
- Models : Build and create packages for the following platforms:
- linux 32bits
- linux 64bits
- win 32bits
- Eclipse plugin for new function wizard :
- If the release is a final release, create a branch from trunk named release-<version number> (eg. release-1.6.2). Building and packaging will be done using this branch.
- Build and create packages
- Bindings (ROpenFLUID) :
- If the release is a final release, create a branch from trunk named release-<version number> (eg. release-1.6.2). Building and packaging will be done using this branch.
- Build and create packages
Deployment
- Upload OpenFLUID packages on SourceForge
- Upload Models packages on dedicated web site (May be ignored in case of intermediate releases)
- Upload Eclipse plugin on dedicated web site (May be ignored in case of intermediate releases)
- Update Downloads page on OpenFLUID website with new available packages (May be ignored in case of intermediate releases)
- Add announcement on OpenFLUID web site
- If the release is a final release, close the related milestone in the OpenFLUID Roadmap
