Difference between revisions of "How to Make a Release"

From OPeNDAP Documentation
(Created page with "== Overview == To plan a sprint there are two basic sets of tasks: cleaning up the left over bugs that have accumulated during the past sprints and then working on a set of pr...")
 
(88 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Overview ==
+
This is an updated set of notes regarding a software release. It is tailored to a release of Hyrax, but the same process can be used for any of our code.
To plan a sprint there are two basic sets of tasks: cleaning up the left over bugs that have accumulated during the past sprints and then working on a set of predictable tasks. This page lists those predictable tasks and some notes about the various releases. In the burndown chart built by Jira, there is a ''Time Spent'' column that tells how long each of the various tasks really took. While it's impossible to predict how long some of the stuff will take, previous performance is the best tool we've got, as they say...
 
  
== Set Tasks for a Release ==
+
# Look for any tickets that have been bound to the label 'fix release x.y.z' and make sure those are completed. Be sure to use both:
;Verify CI and fix as needed.
+
#* The HyraxKB Kanban board in OPeNDAP's JIRA.
;Security review OLFS
+
#* The Hyrax board in our NASA JIRA.
;Source release libdap
+
# When we are ready to release, follow the process outlined in the sections below.
 +
# Once done, close the board
 +
 
 +
== When we decide to release software ==
 +
Use the developers at opendap.org list to send out notices to all the developers about pending releases.
 +
 
 +
=== Planned release ===
 +
If this is a planned release, send out a notice at least two weeks in advance to anyone who likely has made changes to the software. More lead time is, of course, better. This will allow developers time to get their code and documentation changes into github and onto the master branch in time for the release.
 +
 
 +
Run Coverity!
 +
 
 +
=== Emergency releases ===
 +
If this is an 'emergency' release, then send out a notice to developers as soon as the decision to release is made, since this will give a chance for other developers to lets us know if there are new changes in the master branch that are ready for release. if we don't get an email from those developers of a particular component, then we should assume that the code might not be 100% ready for release and we should use the version tagged with/for the last release if possible.
 +
 
 +
Maybe run Coverity - depends on the scope of the changes.
 +
 
 +
== Release Prerequisites  ==
 +
Only start this process when hyrax-dependencies, libdap, bes and OLFS ''master'' branches all building and passing their tests.
 +
 
 +
== Steps For A Major Release (ex: 1.16.x -> 1.17.0) ==
 +
# <span style="text-decoration: line-through;">Security Review for libdap, BES and OLFS</span> Now Handled By TravisCI
 +
# Write a new X.Y web page. See the [https://docs.opendap.org/images/f/fe/Admin_instructions.pdf web site admin notes] for info about this. It has important information about the menu links. Base this on the previous release page's structure/content.
 +
# Follow the remaining steps for a ''minor'' release (below).
 +
 
 +
== Steps For A Minor Release (ex: 1.16.5 -> 1.16.6) ==
 +
; Notes
 +
* ''Committing and pushing the various changes made for the source releases will trigger a binary build and those binaries will have the version numbers made in the source distributions update.''
 +
 
 +
* ''Perform these steps in the order stated as downstream activities rely on items created in earlier steps, such as the creation of the DOIs for libdap and BES are required when updating the OLFS README.md, ''
 +
 
 +
=== Perform the [[Jira Release Process]] ===
 +
 
 +
 
 +
=== hyrax-dependencies: [[Source Release For hyrax-dependencies]] ===
 +
 
 +
=== libdap: [[Source Release for libdap]] ===
 +
 
 +
 
 +
=== BES: [[Source Release for BES]] ===
 +
 
 +
=== OLFS:  [[OLFSReleaseGuide | Source and Binary release for OLFS]] ===
 +
 
 +
=== [[Signing And Publishing C++ Binary Distributions]] ===
 +
: '''Note:''' ''This was already done for the java OLFS in the previous steps.''
 +
 
 +
=== [[HyraxDockerReleaseGuide | Build And Publish Docker Images For The Release]] ===
 +
 
 +
=== Install the new server on test.opendap.org ===
 +
 
 +
== [[Update The Hyrax Release Web Page]] ==
 +
== Send out a notice. ==
 +
 
 +
== Time to complete by release ==
 +
Update and of the release checklists and the 'Time to complete...' information below.
 +
 
 +
* Hyrax 1.12.2: The total time was planned as ''3w 1d 5h'' and turned out as ''1w 2d 2h 10m''.
 +
* Hyrax 1.15.1: ''3d'' calendar time
 +
* Hyrax 1.16.2: ''3d'' effort

Revision as of 15:24, 10 January 2022

This is an updated set of notes regarding a software release. It is tailored to a release of Hyrax, but the same process can be used for any of our code.

  1. Look for any tickets that have been bound to the label 'fix release x.y.z' and make sure those are completed. Be sure to use both:
    • The HyraxKB Kanban board in OPeNDAP's JIRA.
    • The Hyrax board in our NASA JIRA.
  2. When we are ready to release, follow the process outlined in the sections below.
  3. Once done, close the board

1 When we decide to release software

Use the developers at opendap.org list to send out notices to all the developers about pending releases.

1.1 Planned release

If this is a planned release, send out a notice at least two weeks in advance to anyone who likely has made changes to the software. More lead time is, of course, better. This will allow developers time to get their code and documentation changes into github and onto the master branch in time for the release.

Run Coverity!

1.2 Emergency releases

If this is an 'emergency' release, then send out a notice to developers as soon as the decision to release is made, since this will give a chance for other developers to lets us know if there are new changes in the master branch that are ready for release. if we don't get an email from those developers of a particular component, then we should assume that the code might not be 100% ready for release and we should use the version tagged with/for the last release if possible.

Maybe run Coverity - depends on the scope of the changes.

2 Release Prerequisites

Only start this process when hyrax-dependencies, libdap, bes and OLFS master branches all building and passing their tests.

3 Steps For A Major Release (ex: 1.16.x -> 1.17.0)

  1. Security Review for libdap, BES and OLFS Now Handled By TravisCI
  2. Write a new X.Y web page. See the web site admin notes for info about this. It has important information about the menu links. Base this on the previous release page's structure/content.
  3. Follow the remaining steps for a minor release (below).

4 Steps For A Minor Release (ex: 1.16.5 -> 1.16.6)

Notes
  • Committing and pushing the various changes made for the source releases will trigger a binary build and those binaries will have the version numbers made in the source distributions update.
  • Perform these steps in the order stated as downstream activities rely on items created in earlier steps, such as the creation of the DOIs for libdap and BES are required when updating the OLFS README.md,

4.1 Perform the Jira Release Process

4.2 hyrax-dependencies: Source Release For hyrax-dependencies

4.3 libdap: Source Release for libdap

4.4 BES: Source Release for BES

4.5 OLFS: Source and Binary release for OLFS

4.6 Signing And Publishing C++ Binary Distributions

Note: This was already done for the java OLFS in the previous steps.

4.7 Build And Publish Docker Images For The Release

4.8 Install the new server on test.opendap.org

5 Update The Hyrax Release Web Page

6 Send out a notice.

7 Time to complete by release

Update and of the release checklists and the 'Time to complete...' information below.

  • Hyrax 1.12.2: The total time was planned as 3w 1d 5h and turned out as 1w 2d 2h 10m.
  • Hyrax 1.15.1: 3d calendar time
  • Hyrax 1.16.2: 3d effort