Dirk Zimoch
90a727c901
Most errors found with: codespell -L cach,thst,odly,aslo,parm,parms,inpu,ges,prset,pevent,ptd,pring,valu,noo,noe,ned,inout,ro,siz,froms,nd,fo,singl,sart,multy,tthe,allong,ment,inate,nodel,tring,alse,ture,thi,wille,numer Some more manually found (its -> it's) c++20: Do not use apostrophe (e.g. can't) in unquoted #error message
493 lines
18 KiB
HTML
493 lines
18 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<title>EPICS Release Procedures & Checklist</title>
|
|
<style type="text/css" media="print">
|
|
<!--
|
|
body {
|
|
font: 10.5pt/12pt Arial, Helvetica, sans-serif;
|
|
}
|
|
table {
|
|
border-collapse: collapse;
|
|
border: thin solid black;
|
|
}
|
|
tt {
|
|
font: 9pt/11pt "Courier New", fixed;
|
|
}
|
|
td,th {
|
|
padding: 2pt 4pt;
|
|
vertical-align: top
|
|
}
|
|
td blockquote {
|
|
page-break-inside: avoid;
|
|
margin-right: 0;
|
|
}
|
|
-->
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
<h1>EPICS Base Release Procedures & Checklist</h1>
|
|
|
|
<p>This document describes the procedures and provides a checklist of tasks
|
|
that should be performed when creating production releases of EPICS Base.</p>
|
|
|
|
<h3>The Release Process</h3>
|
|
|
|
<p>We used to have one written down here, but we weren't following it very
|
|
closely so now the decision to make a new release is taken during the Core
|
|
Developers bi-weekly meetings in an informal manner. The steps detailed below
|
|
were written to remind Andrew (or anyone else who does the release) about
|
|
everything that has to be done since it's so easy to miss steps.</p>
|
|
|
|
<h3>Roles</h3>
|
|
|
|
<p>The following roles are used below:</p>
|
|
|
|
<dl>
|
|
<dt><strong>Release Manager</strong></dt>
|
|
<dd>Responsible for managing and tagging the release</dd>
|
|
<dt><strong>Core Developers</strong></dt>
|
|
<dd>Responsible for maintaining the EPICS software</dd>
|
|
<dt><strong>Website Editors</strong></dt>
|
|
<dd>Responsible for the EPICS websites</dd>
|
|
</dl>
|
|
|
|
<form>
|
|
<table border="1" width="100%">
|
|
<tbody>
|
|
<tr>
|
|
<th>Check</th>
|
|
<th>Who</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="3">Preparing for a release</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td>Release Manager</td>
|
|
<td>Notify core developers about the upcoming release and ask about any
|
|
remaining tasks that must be finished.</td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td>All developers</td>
|
|
<td>Check the bug tracker for any outstanding items and handle
|
|
appropriately.</td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td>Release Manager</td>
|
|
<td>Set a Feature Freeze date, by which time all Git branches for
|
|
enhancements and new functionality should have been merged. After this
|
|
date, commits and merges should only be made to fix problems that show
|
|
up during testing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td>Release Manager<br>
|
|
& all developers</td>
|
|
<td>Request that documentation be updated and information about new
|
|
features be added before the release date:
|
|
<ul>
|
|
<li>Release Notes</li>
|
|
<li>Doxygen annotations</li>
|
|
<li>Other documents on
|
|
<a href="https://docs.epics-controls.org/en/latest/">
|
|
docs.epics-controls.org</a></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td>Release Manager</td>
|
|
<td>Review and update this checklist for the upcoming release.
|
|
Update the release version number in the tags and messages below.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="3">Testing</th>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td>Platform Developers</td>
|
|
<td>Run the internal test programs on all appropriate platforms.</td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td>Platform Developers</td>
|
|
<td>Check that all makeBaseApp templates build and run properly, all
|
|
<i>xxxApp</i> and <i>xxxBoot</i> types and any internal options, e.g.
|
|
setting <tt>STATIC_BUILD=YES</tt> or using a different
|
|
<tt>INSTALL_LOCATION</tt> in configure/CONFIG_SITE.</td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td>Release Manager</td>
|
|
<td>Check that documentation has been updated:
|
|
<ul>
|
|
<li>Release Notes</li>
|
|
<li>Doxygen annotations</li>
|
|
<li>Other documents on
|
|
<a href="https://docs.epics-controls.org/en/latest/">
|
|
docs.epics-controls.org</a></li>
|
|
</ul>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th colspan="3" id="ReleaseApproval">
|
|
Release Approval</th>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Core Developers</td>
|
|
<td>Reach a consensus that the software is ready to release.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="3">Creating the final release version</th>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td>
|
|
<h4>For each external submodule to be tagged</h4>
|
|
<ol>
|
|
<li><tt>cd base-7.0/modules/<module>; git grep UNRELEASED</tt>
|
|
and insert the submodule's version number into any doxygen
|
|
annotations that have a <tt>@since UNRELEASED</tt> comment.
|
|
Commit (don't push yet).</li>
|
|
|
|
<li>Check that the submodule's Release Notes have been updated to
|
|
cover all changes; add missing items as necessary, and set the
|
|
module version number and release date if appropriate.<br>
|
|
Commit the changes to the submodule's Notes file (don't push).</li>
|
|
|
|
<li>Copy the new submodule version number and Release Notes entries
|
|
into a new file named <tt><i>module</i>-<i>release</i></tt> in the
|
|
<tt>base-7.0/documentation/new-notes</tt> directory.</li>
|
|
|
|
<li>Edit the module's release version file
|
|
<tt>configure/CONFIG_<i>module</i>_VERSION</tt> and the
|
|
<tt>Doxyfile</tt>s in the top-level and/or documentation
|
|
directories. In these, set <tt>DEVELOPMENT_FLAG=0</tt> and remove
|
|
<tt>-dev</tt> from the <tt>PROJECT_NUMBER</tt> string. Commit these
|
|
changes (don't push):
|
|
<blockquote><tt>
|
|
git commit -m 'Final commit for <submodule-version>'
|
|
</tt></blockquote>
|
|
</li>
|
|
|
|
<li>Tag the submodule:
|
|
<blockquote><tt>
|
|
git tag -m 'ANJ: Tag for EPICS 7.0.9.1' <submodule-version>
|
|
</tt></blockquote>
|
|
</li>
|
|
|
|
<li>Generate documentation for modules with <tt>release_notes.dox</tt>
|
|
files. Prepare to update the github-pages website as follows:
|
|
<blockquote><tt>
|
|
cd base-7.0/modules/<module>/documentation<br>
|
|
make commit<br>
|
|
git push --force upstream gh-pages
|
|
</tt></blockquote>
|
|
<i>Q: Delay this <tt>git push</tt> until later?</i></li>
|
|
|
|
<li>Update the Git submodule on the Base-7.0 branch to the
|
|
newly-tagged version, check the module's status matches the tag:
|
|
<blockquote><tt>
|
|
cd base-7.0/modules<br>
|
|
git add <module><br>
|
|
git submodule status --cached
|
|
</tt></blockquote>
|
|
Don't commit the submodule updates yet.
|
|
</li>
|
|
|
|
<li>Edit the module's release version file
|
|
<tt>configure/CONFIG_<i>module</i>_VERSION</tt> and its top-level
|
|
<tt>Doxyfile</tt>; increment the <tt>MAINTENANCE_VERSION</tt>, set
|
|
the <tt>DEVELOPMENT_FLAG</tt> value to 1, and update the
|
|
<tt>PROJECT_NUMBER</tt> string, appending <tt>-dev</tt> to the new
|
|
module version number. Commit changes.</li>
|
|
|
|
<li>Push commits and the new tag to the submodule's GitHub repository
|
|
(assumed to be the <tt>upstream</tt> remote):
|
|
<blockquote><tt>
|
|
cd base-7.0/modules/<module><br>
|
|
git push --follow-tags upstream master
|
|
</tt></blockquote>
|
|
</li>
|
|
|
|
</ol></td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td>
|
|
<h4>After all submodules have been updated:</h4>
|
|
<ol>
|
|
|
|
<li> Commit the submodule updates which were added for each submodule
|
|
in step 7 above to the 7.0 branch (don't push):
|
|
<blockquote><tt>
|
|
cd base-7.0/modules<br>
|
|
git commit -m "Update git submodules for release"
|
|
</tt></blockquote></li>
|
|
|
|
<li>Make sure that the output from
|
|
<tt>git submodule status --cached</tt> only shows the appropriate
|
|
version tags in the right-most parenthesized column with no
|
|
<tt>-<i>n</i>-g<i>xxxxxxx</i></tt> suffix.</li>
|
|
|
|
<li>Add and commit the new Release Note entry files that were created
|
|
for each submodule in step 3 above (don't push):
|
|
<blockquote><tt>
|
|
cd base-7.0/documentation<br>
|
|
git add new-notes<br>
|
|
git commit -m "Add submodule release note entries"
|
|
</tt></blockquote></li>
|
|
|
|
</ol>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
|
|
<td>
|
|
<h4>In the main epics-base repository</h4>
|
|
<ol>
|
|
<li><tt>cd base-7.0; git grep UNRELEASED</tt> and insert the release
|
|
version to any doxygen annotations that have a
|
|
<tt>@since UNRELEASED</tt> comment. Commit (don't push).</li>
|
|
|
|
<li>Edit the main EPICS Base version file and the built-in module
|
|
version files:
|
|
<ul>
|
|
<li><tt>configure/CONFIG_BASE_VERSION</tt></li>
|
|
<li><tt>configure/CONFIG_LIBCOM_VERSION</tt></li>
|
|
<li><tt>configure/CONFIG_CA_VERSION</tt></li>
|
|
<li><tt>configure/CONFIG_DATABASE_VERSION</tt></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li>Version numbers should be set according to the level of changes
|
|
made since the last release. Note that the
|
|
<tt>MAINTENANCE_VERSION</tt> or <tt>PATCH_LEVEL</tt> value will have
|
|
been incremented immediately after the previous release tag was
|
|
applied, so don't double-increment them. Set all
|
|
<tt>DEVELOPMENT_FLAG</tt> values to 0 and set the
|
|
<tt>EPICS_DEV_SNAPSHOT</tt> to an empty string (no quotes).</li>
|
|
|
|
<li>Commit the above changes (don't push):
|
|
<blockquote><tt>
|
|
cd base-7.0<br>
|
|
git add configure/CONFIG_*_VERSION<br>
|
|
git commit -m "Set core version numbers for release"
|
|
</tt></blockquote></li>
|
|
|
|
<li><p>When <tt>EPICS_DEV_SNAPSHOT</tt> is empty because a release is
|
|
being created, the <tt>documentation/Makefile</tt> supports a build
|
|
target <tt>release</tt> for creating a new release notes file
|
|
<tt>documentation/RELEASE-<i>version</i>.md</tt> from the Markdown
|
|
files in the <tt>documentation/new-notes</tt> directory. When run,
|
|
it copies the notes entries from all the <tt>new-notes/*.md</tt>
|
|
files, then deletes the files and prepares a Git commit to apply
|
|
those changes permanently to the repository.</p>
|
|
|
|
<p>Run these commands to generate the <tt>RELEASE-7.0.9.1.md</tt>
|
|
file and remove the individual release note entry files:</p>
|
|
|
|
<blockquote><tt>
|
|
cd base-7.0/documentation<br>
|
|
make
|
|
</tt></blockquote></li>
|
|
|
|
<li>The <tt>make release</tt> command add some changes into the Git
|
|
index but didn't commit them. These commands let you check what
|
|
was done and commit the result (don't push yet!):
|
|
|
|
<blockquote><tt>
|
|
git status<br>
|
|
git diff --staged<br>
|
|
git commit -m "Generate RELEASE-7.0.9.1.md notes file"
|
|
</tt></blockquote>
|
|
|
|
To undo those Git actions and confirm that happened, run these:
|
|
|
|
<blockquote><tt>
|
|
make unrelease<br>
|
|
git status
|
|
</tt></blockquote></li>
|
|
</ol>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td>Tag the epics-base module in Git:
|
|
<blockquote><tt>
|
|
cd base-7.0<br>
|
|
git tag -m 'ANJ: Tagged for release' R7.0.9.1
|
|
</tt></blockquote>
|
|
<p>Don't push to GitHub yet.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td><h4>After tagging the release</h4>
|
|
Edit the main EPICS Base version file and the built-in module version
|
|
files:
|
|
<ul>
|
|
<li><tt>configure/CONFIG_BASE_VERSION</tt></li>
|
|
<li><tt>configure/CONFIG_LIBCOM_VERSION</tt></li>
|
|
<li><tt>configure/CONFIG_CA_VERSION</tt></li>
|
|
<li><tt>configure/CONFIG_DATABASE_VERSION</tt></li>
|
|
</ul>
|
|
<p>Version numbers should be set for the next expected patch/maintenance
|
|
release by incrementing the MAINTENANCE_VERSION or PATCH_LEVEL value
|
|
in each file. Set all <tt>DEVELOPMENT_FLAG</tt> values to 1 and
|
|
<tt>EPICS_DEV_SNAPSHOT</tt> to "-DEV".</p>
|
|
<p>Set up the headings in the Release Notes for the next release
|
|
version number and restore the warning about this being an unreleased
|
|
version of EPICS.</p>
|
|
<p>Commit these changes (don't push).</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td>Export the tagged version into a tarfile. The <tt>make-tar.sh</tt>
|
|
script generates a gzipped tarfile directly from the tag, excluding the
|
|
files and directories that are only used for continuous integration:
|
|
<blockquote><tt>
|
|
cd base-7.0<br>
|
|
./.tools/make-tar.sh R7.0.9.1 ../base-7.0.9.1.tar.gz base-7.0.9.1/
|
|
</tt></blockquote>
|
|
Create a GPG signature file of the tarfile as follows:
|
|
<blockquote><tt>
|
|
cd ..<br>
|
|
gpg --armor --sign --detach-sig base-7.0.9.1.tar.gz
|
|
</tt></blockquote>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td>Test the tar file by extracting its contents and building it on at
|
|
least one supported platform. If this succeeds the commits and new git
|
|
tag can be pushed to the GitHub repository's 7.0 branch (assumed to be
|
|
the <tt>upstream</tt> remote):
|
|
<blockquote><tt>
|
|
git push --follow-tags upstream 7.0
|
|
</tt></blockquote>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="3">Publish to epics.anl.gov</th>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Website Editor</td>
|
|
<td>Copy the tarfile and its signature to the Base download area of the
|
|
website.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Website Editor</td>
|
|
<td>Add the new release tar file to the website Base download index
|
|
page.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Website Editor</td>
|
|
<td>Create or update the website subdirectory that holds the release
|
|
documentation, and copy in the files to be published with this
|
|
release version.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Website Editor</td>
|
|
<td>Update the webpage for the new release with links to the release
|
|
documents and tar file.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Website Editor</td>
|
|
<td>Link to the release webpage from other relevant areas of the
|
|
website - update front page and sidebars.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Website Editor</td>
|
|
<td>Add an entry to the website News page, linking to the new version
|
|
webpage.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th colspan="3">Publish to epics-controls.org</th>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Website Editor</td>
|
|
<td>Upload the tar file and its <tt>.asc</tt> signature file to the
|
|
epics-controls web-server.
|
|
<blockquote><tt>
|
|
scp base-7.0.9.1.tar.gz base-7.0.9.1.tar.gz.asc epics-controls:download/base<br>
|
|
</tt></blockquote>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Website Editor</td>
|
|
<td><p>Follow instructions on
|
|
<a href="https://epics-controls.org/resources-and-support/documents/epics-website-documentation/adding-a-page-for-a-new-release/">
|
|
Add a page for a new release</a> to create a new release webpage (not
|
|
required for a patch release, just edit the existing page). Update the
|
|
TablePress "Point Releases" table and add the new download, and adjust
|
|
the Html Snippet for the series download.</p>
|
|
<p>Not covered in those instructions: Go to Posts, find a previous
|
|
release and use "Duplicate Post", then edit the result and publish it.
|
|
This generates the News item.
|
|
</p></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th colspan="3">Publish to GitHub</th>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td>Go to the GitHub
|
|
<a href="https://github.com/epics-base/epics-base/releases/new?tag=R7.0.9.1">
|
|
Create release from tag R7.0.9.1</a> page.
|
|
Upload the tar file and its <tt>.asc</tt> signature file to the new
|
|
GitHub release page, or just drag-n-drop them into the page.
|
|
Copy/paste the text from the previous release and edit. Submit.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td>We used to close out bug reports in Launchpad at release-time, this
|
|
would be the time to do that if we have an equivalent on GitHub.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th colspan="3">Make Announcement</th>
|
|
</tr>
|
|
<tr>
|
|
<td><input type="checkbox"></td>
|
|
<td>Release Manager</td>
|
|
<td>Announce the release on the tech-talk mailing list.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</form>
|
|
</body>
|
|
</html>
|