Page MenuHomePhorge
Files F375484

Release.rst
No OneTemporary
Actions

Size
1 KB
Referenced Files
None
Subscribers
None

Release.rst
View Options

=============================================
Releasing a new version of the RoSA Framework
=============================================
.. contents::
:local:
Before Releasing
================
:ref:`General recommendations <Dev Managing Sources>` 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 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:
* `docs/doxygen` and `docs/html` from the build directory;
* packages for download.

File Metadata

Mime Type
text/plain
Expires
Sun, Jun 8, 1:41 AM (1 d, 3 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
148231
Default Alt Text
Release.rst (1 KB)

Event Timeline