Differences

This shows you the differences between two versions of the page.

--- for_developers:releaseprocess [2019/01/25 14:35] – update a few chapters kunz
+++ for_developers:releaseprocess [2024/12/18 11:33] (current) – [2. Creation of a new release branch] ursgraf
@@ Line 35: / Line 35: @@
 The EEROS release workflow supports multiple active releases. Therefore, every release is created on a release branch. The name of the release branch contains the //MAJOR.MINOR// part of the release number. Only the release tags contain the full pattern.
-Since the development is done on the master branch, the release branch is created based on the HEAD of the master branch. The following git commands will create the new release branch (release/1.0 is used as an example):
+Since the development is done on the master branch, the release branch is created based on the HEAD of the master branch. The following git commands will create the new release branch (v1.0 is used as an example):
 <code>
@@ Line 45: / Line 45: @@
 <code>
 git push --set-upstream origin v1.0
+</code>
+Probably you already have a release branch, e.g. do want to release v1.0.3 and still have your branch for v.1.0.2. If so, switch to branch v1.0 and **merge your master branch** (or whatever work you want to be included) into the release branch.
+<code>
+git checkout v1.0
+git merge master
 </code>
@@ Line 97: / Line 103: @@
 It is very important, that the right release branch is selected. The form must be completed as shown in the picture below.
-//insert picture//
+{{:for_developers:release_v1.0.0_github_1.png?nolink|}}
+Note that the information in the description section is copied from the change log.
@@ Line 120: / Line 128: @@
 The change is committed and pushed.
+<code>
+git add *CHANGELOG.md*
+git commit -m "Add unreleased section"
+git push
+</code>
 ==== 8. Generate the API documentation with Doxygen  ====
-The second last step is to update the [[http://api.eeros.org/|API]] documentation on the EEROS Website. The HTML files are generated with Doxygen. The following command on the release branch is issued, to start Doxygen:
+The second last step is to update the [[http://api.eeros.org/|API]] documentation on the EEROS Website. The HTML files are generated with Doxygen, which must be installed before the make script of EEROS runs. The following command on the release branch starts the process:
 <code>
-... eeros-framework/buildFolder$ doxygen Doxyfile
+... eeros-framework/buildFolder$ make doc
 </code>
-The documentation is found at the path //eeros-framework/buildFolder/doc/html//. The HTML documentation is uploaded as described below:
+The documentation can be found in **eeros-framework/buildFolder/doc/html**. It must be uploaded by the administrator to the EEROS Website.
-//describe upload.//
 ==== 9. Creation of a new card to discuss suggestions for improvement  ====