diff --git a/documentation/ReleaseChecklist.html b/documentation/ReleaseChecklist.html index 2f7a04065..ac8874829 100644 --- a/documentation/ReleaseChecklist.html +++ b/documentation/ReleaseChecklist.html @@ -4,19 +4,40 @@ - EPICS Release Procedures Checklist + EPICS Release Procedures & Checklist + -

EPICS Base Release Procedures Checklist

+

EPICS Base Release Procedures & Checklist

$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.

The Release Process

@@ -24,22 +45,30 @@ welcome.

pre-release, -pre1. The first Release Candidate -RC1 is the first version that has undergone widespread testing and which has no known problems in it that are slated to be fixed in this release. New versions should -be made at about weekly intervals during the testing and debugging process, and +be made at about weekly intervals during the testing and debugging period, and will be designated as either pre-release versions or Release Candidates by the Release Manager. A Release Candidate that has received widespread testing for a -week without any additional problems being discovered or CVS commits being made -can be designated as the final release.

+week without any additional problems being discovered or significant changes +being committed can be designated as the final release version.

Roles

-

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
+
Release Manager (Andrew Johnson)
Responsible for the release
+
Configuration Manager (Janet Anderson)
+
Responsible for committing version number updates to CVS and for + creating tarfiles
Platform Developers
Responsible for individual operating system platforms
+
Application Developers
+
Responsible for support modules that depend on EPICS Base.
+
Website Manager (Andrew Johnson)
+
Responsible for the EPICS website
@@ -75,9 +104,9 @@ have been responsible for specific tasks in the past:

- - + - + - + - + - - + - + - + - + + release documents and tar file. Pre-release and RC versions should use + the page and URL for the final release version number. - + + page. @@ -150,33 +179,43 @@ have been responsible for specific tasks in the past:

- + + + + + + + + + + + STATIC_BUILD=YES in configure/CONFIG_SITE. + the makeBaseApp example builds and runs correctly with it. - - - - - - - + + @@ -196,28 +235,28 @@ have been responsible for specific tasks in the past:

- + - + - + - + - + - + - + - + @@ -253,26 +292,26 @@ have been responsible for specific tasks in the past:

- + + page. - + + website - update front page and sidebars. - - + + - + + have been fixed in this release. @@ -281,9 +320,9 @@ have been responsible for specific tasks in the past:

- + + webpage.
 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:
  • Application Developers Guide
  • Release Notes
    • @@ -91,13 +120,13 @@ have been responsible for specific tasks in the past:

 Janet AndersonConfiguration Manager Edit and commit changes to the EPICS version number file configure/CONFIG_BASE_VERSION.
 Janet AndersonConfiguration 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 AndersonConfiguration 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
@@ -115,34 +144,34 @@ have been responsible for specific tasks in the past:

 Janet AndersonTest the tar file by extracting its contents and building it on at + Configuration ManagerTest the tarfile by extracting its contents and building it on at least one supported platform
 Janet AndersonConfiguration Manager Copy the tar file to the Base download area of the website
 Andrew JohnsonWebsite 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 JohnsonWebsite 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.
 Andrew JohnsonWebsite Manager Add the new pre-release tar file to the website Base download index - page.
Testing
  Platform DevelopersRun 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 DevelopersRun the CA client side regression tests on all available host platforms.
 Platform DevelopersBuild 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.
  Platform Developers Build the SNL Sequencer against this version of Base, and check that - the makeBaseApp example builds and runs correctly with it.
 Marty KraimerRun the VME I/O tests in mrkHwdTest on all available vxWorks VME - platforms.
 Jeff HillRun the CA client side regression tests on all available host - platforms.Application DevelopersBuild 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.
 
  Release ManagerObtain 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 release from all platform developers + when a Release Candidate version has gone a whole week without any + issues being reported.
Creating the final release version
 Janet AndersonConfiguration Manager Edit and commit changes to the EPICS version number file configure/CONFIG_BASE_VERSION.
 Janet AndersonConfiguration Manager Tag the module in CVS. Official base release version tags take the form Rx-y-z[-n]
 Janet AndersonConfiguration 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
@@ -226,25 +265,25 @@ have been responsible for specific tasks in the past:

 Janet AndersonConfiguration Manager Test the tar file by extracting its contents and building it on at least one supported platform
 Janet AndersonConfiguration Manager Copy the tar file to the Base download area of the website
 Andrew JohnsonWebsite Manager Update the website subdirectory that holds the release documentation, and copy in the files from the base/documentation directory of the tarfile.
 Andrew JohnsonWebsite Manager Update the webpage for the new release with links to the release documents and tar file.
 Andrew JohnsonWebsite Manager Add the new release tar file to the website Base download index - page
 Andrew JohnsonWebsite Manager Link to the release webpage from other relevent areas of the - website - update front page and sidebars
 Andrew JohnsonAdd the new Version number to the Mantis bug trackerWebsite ManagerAdd the new Version number to the Mantis bug tracker.
 Andrew JohnsonWebsite Manager Close all Mantis bug reports that were marked as resolved and which - have been fixed in this release
 
 Andrew JohnsonWebsite Manager Add an entry to the website News page, linking to the new version - webpage