Changes between Initial Version and Version 1 of WikiStart/Admin/Releasing


Ignore:
Timestamp:
06/19/13 15:32:19 (6 years ago)
Author:
sylvain.joyeux
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart/Admin/Releasing

    v1 v1  
     1This page will describe the workflow about how to release 'next' to the new 'stable' flavor 
     2 
     3You need first: 
     4 
     5 * to get into a full, uptodate, bootstrap of the next branch 
     6 * to get the admin scripts checked out in this bootstrap: add base/admin_scripts in autoproj/manifest and run aup admin_scripts 
     7 
     8== First Step: Synchronize 'stable' and 'next' == 
     9 
     10It is possible that some commits in stable are not yet in next. To verify this, run: 
     11 
     12{{{ 
     13ROCK_FORCE_FLAVOR=stable autoproj status 
     14}}} 
     15 
     16In the status messages, the 'remote' is stable and the 'local' is next. If remote has commits than 'stable' does not have, you should either: 
     17 
     18 - integrate them in 'next' by merging them: 
     19   {{{ 
     20   acd name/of/package 
     21   git pull autobuild stable 
     22   git push autobuild next 
     23   }}} 
     24 - ignore them completely (if, for instance, the changes are bugfixes that do not apply to the current state of 'next') 
     25   {{{ 
     26   acd name/of/package 
     27   git remote update 
     28   git merge -s ours autobuild/stable 
     29   git push autobuild next 
     30   }}} 
     31 
     32Do this until there are no commits in 'stable' that are not in 'next' 
     33 
     34== Second Step: push 'next' to 'stable' == 
     35 
     36The admin scripts contain the rock-release script that performs the 'push to stable' operations, namely: 
     37 
     38 - generate status pages (which will become the changelog entry for this release) 
     39 - tag the current state 
     40 - push it to next 
     41 
     42Run it with 
     43 
     44{{{ 
     45rock-release 
     46}}} 
     47 
     48Note that this script is (mostly) idempotent: you can re-run it until it passes. 
     49 
     50== Third: update the rock package sets, commit the changelog == 
     51 
     52The rock-release script generates two documentation pages: 
     53 
     54 - stable-$date.page: the status BEFORE the synchronization 
     55 - stable-$date-final.page: the status AFTER the synchronization 
     56 
     57Where $date is a date tag for the date in which the release is being made. 
     58 
     59With the latter, you get the list of packages that are currently NOT on stable and should be put there. Modify autoproj/remote/rock*/*.autobuild to move the package definitions from the 'master', 'next' sections into the 'master', 'next', 'stable' sections. Commit but '''do not push yet'''. First run a complete build. 
     60 
     61With the former, you can create the changelog entry. It should be first modified to change the wording (e.g. "are in next but not in stable" becomes "new commits" and so on), compare [http://rock-robotics.org/stable/changelog/ the existing changelogs] with the generated pages to see what should be done there. Moreover, you have to add a title block. See files in the src/changelog subfolder of [http://rock-robotics.org/stable/documentation/contributing/documentation.html the Rock website repository] for example.  
     62 
     63Once the page is modified to fit the "changelog" wording, copy it into the src/changelog/stable-update-$date.page file [http://rock-robotics.org/stable/documentation/contributing/documentation.html in the Rock website repository], on all master, next and stable branches (add to stable and merge stable to next, next to master). Push all. 
     64 
     65Finally, '''start a bootstrap on the build server''' 
     66 
     67== Final: announce ! == 
     68 
     69Create an announcement message pointing to the changelog page (once the new bootstrap build on the build server is finished, the documentation/website should be generated and therefore the new changelog should appear). See former announcements for examples. The announcement is usually done on the blog as well as on the rock-dev and orocos-users mailing lists. 
     70 
     71If there are "highlights", i.e. really important new features, feel free to highlight them there.