From 2dc00205138b4531f9ec6730ff0aa78826b52cad Mon Sep 17 00:00:00 2001
From: Andrew Johnson $Id$ This document is a checklist of things that must be done when creating a
-new release of EPICS Base. Additions and ammendments to this list are
-welcome. This document describes the procedures and provides a checklist of tasks
+that should be performed when creating new releases of EPICS Base.EPICS Base Release Procedures Checklist
+EPICS Base Release Procedures & Checklist
-The Release Process
@@ -24,22 +45,30 @@ welcome.
The following roles are used, in addition to the names of individuals who -have been responsible for specific tasks in the past:
+The following roles are required. The individuals named here have have been +responsible for these tasks in the past and are expected to continue in the +relevent roles unless the Release Manager designates otherwise:
| - | Release Manager & - all developers |
- Ensure that documentation will be updated before the release date: + | Release Manager + & all developers |
+ Ensure that documentation will be updated before the release date:
|
| - | Janet Anderson | +Configuration Manager | Edit and commit changes to the EPICS version number file configure/CONFIG_BASE_VERSION. | |
| - | Janet Anderson | +Configuration Manager | Tag the module in CVS. Pre-release version tags take the form Rx-y-z-pren while Release Candidate tags take the form @@ -106,7 +135,7 @@ have been responsible for specific tasks in the past: | |
| - | Janet Anderson | +Configuration Manager | Export the tagged version and create a tarfile of the result:
cvs export -kv -d base-x.y.z-pre1 -r Rx-y-z-pre1 epics/base | |
| - | Janet Anderson | -Test the tar file by extracting its contents and building it on at + | Configuration Manager | +Test the tarfile by extracting its contents and building it on at least one supported platform |
| - | Janet Anderson | +Configuration Manager | Copy the tar file to the Base download area of the website | |
| - | Andrew Johnson | +Website Manager | Create or update a website subdirectory to hold the release documentation, and copy in the files from the base/documentation directory of the tarfile. | |
| - | Andrew Johnson | +Website Manager | Create or modify the webpage for the new release with links to the - release documents and tar file. Pre-release versions should use the - page and URL for the final release version number. | + release documents and tar file. Pre-release and RC versions should use + the page and URL for the final release version number.|
| - | Andrew Johnson | +Website Manager | Add the new pre-release tar file to the website Base download index - page. | + page.|
| Testing | @@ -150,33 +179,43 @@ have been responsible for specific tasks in the past:||||
|---|---|---|---|---|
| Platform Developers | -Run the Soft IOC tests from mrkSoftTest on all available + | Run the built-in test programs on all available host platforms using
+ + make -s runtests + |
+ ||
| + | Platform Developers | +Run the CA client side regression tests on all available host platforms. | ||
| + | Platform Developers | +Build and run the + IOC Soft-Test + suite on all available platforms. | +||
| Platform Developers | Check that all makeBaseApp templates build and run properly, all xxxApp and xxxBoot types and any internal options, e.g. setting - STATIC_BUILD=YES in the configure/CONFIG_SITE. | + STATIC_BUILD=YES in configure/CONFIG_SITE.|||
| Platform Developers | Build the SNL Sequencer against this version of Base, and check that - the makeBaseApp example builds and runs correctly with it. | + the makeBaseApp example builds and runs correctly with it.|||
| - | Marty Kraimer | -Run the VME I/O tests in mrkHwdTest on all available vxWorks VME - platforms. | -||
| - | Jeff Hill | -Run the CA client side regression tests on all available host - platforms. | +Application Developers | +Build external applications against this version of Base on all + available platforms and test as appropriate. Application code changes + may be necessary where the EPICS Base APIs have been modified. |
| @@ -196,28 +235,28 @@ have been responsible for specific tasks in the past: | ||||
| Release Manager | -Obtain a positive 'Ok to release' from all platform developers when a - Release Candidate version has gone a whole week without any issues being - reported. | +Obtain a positive Ok to releasefrom all platform developers + when a Release Candidate version has gone a whole week without any + issues being reported. |
||
| Creating the final release version | ||||
| - | Janet Anderson | +Configuration Manager | Edit and commit changes to the EPICS version number file configure/CONFIG_BASE_VERSION. | |
| - | Janet Anderson | +Configuration Manager | Tag the module in CVS. Official base release version tags take the form Rx-y-z[-n] | |
| - | Janet Anderson | +Configuration Manager | Export the tagged version and create a tarfile of the result:
cvs export -kv -d base-x.y.z -r Rx-y-z epics/base | |
| - | Janet Anderson | +Configuration Manager | Test the tar file by extracting its contents and building it on at least one supported platform | |
| - | Janet Anderson | +Configuration Manager | Copy the tar file to the Base download area of the website | |
| - | Andrew Johnson | +Website Manager | Update the website subdirectory that holds the release documentation, and copy in the files from the base/documentation directory of the tarfile. | |
| - | Andrew Johnson | +Website Manager | Update the webpage for the new release with links to the release documents and tar file. | |
| - | Andrew Johnson | +Website Manager | Add the new release tar file to the website Base download index - page | + page.|
| - | Andrew Johnson | +Website Manager | Link to the release webpage from other relevent areas of the - website - update front page and sidebars | + website - update front page and sidebars.|
| - | Andrew Johnson | -Add the new Version number to the Mantis bug tracker | +Website Manager | +Add the new Version number to the Mantis bug tracker. |
| - | Andrew Johnson | +Website Manager | Close all Mantis bug reports that were marked as resolved and which - have been fixed in this release | + have been fixed in this release.|
| @@ -281,9 +320,9 @@ have been responsible for specific tasks in the past: | ||||
| - | Andrew Johnson | +Website Manager | Add an entry to the website News page, linking to the new version - webpage | + webpage.|