User Tools

Site Tools


for_developers:releaseprocess

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
for_developers:releaseprocess [2019/01/30 10:57]
kunz Improve chapter 6 & 8
for_developers:releaseprocess [2019/03/28 16:19] (current)
graf [8. Generate the API documentation with Doxygen]
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. 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>​ <​code>​
Line 126: Line 126:
 ==== 8. Generate the API documentation with Doxygen ​ ==== ==== 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. The following command on the release branch ​starts the process:
  
 <​code>​ <​code>​
-... eeros-framework/​buildFolder$ ​doxygen Doxyfile+... eeros-framework/​buildFolder$ ​make doc
 </​code>​ </​code>​
  
-The documentation ​is found at the path **eeros-framework/​buildFolder/​doc/​html**. It is uploaded by the administrator ​of the EEROS Website. He must be contacted using the [[http://​eeros.org/​wordpress/​contact/​|contact form]]. Afterwards, he will answer with the procedure to hand over the files.+The documentation ​can be found in **eeros-framework/​buildFolder/​doc/​html**. It must be uploaded by the administrator ​to the EEROS Website.
  
  
for_developers/releaseprocess.1548842272.txt.gz · Last modified: 2019/01/30 10:57 by kunz