diff --git a/docs/Release.rst b/docs/Release.rst index e530e43..3e8c3bf 100755 --- a/docs/Release.rst +++ b/docs/Release.rst @@ -1,61 +1,65 @@ ============================================= Releasing a new version of the RoSA Framework ============================================= .. contents:: :local: Before Releasing ================ :ref:`General recommendations ` should be applied continually for each separate commit. Nevertheless, check the current state of sources against those recommendations before creating a release. Make sure that the changelog is reasonably updated. Validate that the project builds and the framework can be executed without errors on all supported platforms. Generating a Release ==================== Once it is decided to generate a release, follow the steps below. #. Set version number of the new release: * CMake variables in the main `CMakeLists.txt`: `ROSA_VERSION_MAJOR`, `ROSA_VERSION_MINOR`, `ROSA_VERSION_PATCH`; * Sphinx configuration in `docs/conf.py`: * `version` as "`ROSA_VERSION_MAJOR.ROSA_VERSION_MINOR`", * `release` as "`ROSA_VERSION_MAJOR.ROSA_VERSION_MINOR.ROSA_VERSION_PATH`"; * Changelog in `docs/Changelog.rst`. #. Commit the version number update and tag the release. #. Create packages: * source package -- just the source directory; * binary packages for supported platform: .. _Release_create_build: * create `RELEASE` build without assertions and without logging, .. _Release_package_content: * the package contains: - * all generated documentation in `docs` -- use `doxygen-rosa`, + * all generated documentation as `docs/doxygen`, `docs/html`, and + `docs/man` in the build directory -- use `doxygen-rosa`, `docs-rosa-html`, and `docs-rosa-man` targets for *make*, * public headers -- `include` from source and build directories -- in `include`, * libraries in `lib`, * tool executables in `tools`. #. Publish on website: - * HTML documentation as is; + * HTML documentation: + + * `docs/doxygen` and `docs/html` from the build directory; + * packages for download.