BBP Release Steps - Revision history

Fsilva at 21:28, 28 June 2019

2019-06-28T21:28:25Z

Fsilva: /* Preparing Release Candidate */

2019-06-11T17:25:28Z

Preparing Release Candidate

Fsilva: /* Preparing Release Candidate */

2019-06-11T17:11:08Z

Preparing Release Candidate

Fsilva: /* Preparing Release Candidate */

2019-06-11T17:09:15Z

Preparing Release Candidate

Fsilva at 16:46, 9 June 2019

2019-06-09T16:46:09Z

Fsilva at 20:59, 6 June 2019

2019-06-06T20:59:43Z

Fsilva at 20:59, 4 June 2019

2019-06-04T20:59:00Z

Fsilva at 17:53, 4 June 2019

2019-06-04T17:53:22Z

Fsilva: Created page with "= Steps For Releasing Broadband Platform = These are the steps needed for making a Broadband Platform release. === Code Freeze === The first step for a BBP release is to co..."

2019-06-04T17:25:04Z

Created page with "= Steps For Releasing Broadband Platform = These are the steps needed for making a Broadband Platform release. === Code Freeze === The first step for a BBP release is to co..."

New page

= Steps For Releasing Broadband Platform =

These are the steps needed for making a Broadband Platform release.

=== Code Freeze ===

The first step for a BBP release is to collect the latest codes from all science teams. Ideally, each science team will have reviewed their results and signed off on their method before the code freeze. This will avoid surprises and delays later in the release process.

* Announce code freeze date
* Collect code and parameter changes
* Run simulations as needed
** Single realizations
*** Useful to make sure codes work
** Cluster testing
*** Useful to explore different realizations, create validation sets
* Share results with science teams
* Obtain approval from each science team

=== Science Review ===

These are the steps for a science review of the BBP:

* Make sure cluster has latest versions of everything, use 'diff -r' to make sure source distribution, bbp_gf, and bbp_val are in sync
* rsync needed packages in bbp_gf to /staging
* Run Part-A and Part-B full validations for each method
** Can use XXXX_a.sh and XXXX_b.sh scripts (where XXXX is each method)
*** Create and submits to cluster all validation events for that method
* Plot results
** plot_XXX_a.sh and plot_XXX_b.sh scripts will generate the needed plots automatically

← Older revision		Revision as of 21:28, 28 June 2019
Line 129:		Line 129:

	=== Create Final Release ===		=== Create Final Release ===
		+
		+	To merge the 'dev' branch into the 'master' branch, assuming 'dev' branch is checked out:
		+
		+	* Make sure local repository is in sync with GitHub using 'git status', you should see a message like "nothing to commit, working directory clean". If not, 'git push' your local changes or 'git pull' GitHub's changes first
		+	* Switch to the master branch with 'git checkout master'
		+	* Merge the 'dev' branch into 'master' with 'git merge dev'
		+	* Resolve any conflicts
		+	* Commit the merge with 'git commit -m "Merged dev branch with 19.4.0 release into master"'
		+	* Push changes to GitHub with 'git push'
		+
		+	To create a tag for the release, use:
		+
		+	* git tag 19.4.0 -a -m "BBP Release 19.4.0"
		+	* git push --tags
		+
		+

	=== Release Announcement ===		=== Release Announcement ===

@@ Line 108: / Line 108: @@
 These are the steps needed for a release candidate:
 * Check directories for unused files. It is easier to keep development and testing separate to avoid many of these files but, in any case, look for and delete:
 ** *.pyc
@@ Line 115: / Line 122: @@
 ** *.o
 * Update 'doc/MANIFEST' file with the command 'ls -lghR > doc/MANIFEST'
-* Create 'setup/bbp-<VERSION>-md5.txt' file with the md5 sums of all validation and region packages
+* Create 'setup/bbp-<VERSION>-md5.txt' file with the md5 sums of all validation and region packages created above
 * Update 'setup/easy_install_bbp_<VERSION>.sh' installation script
 ** Change VERSION tag at the top

@@ Line 108: / Line 108: @@
 These are the steps needed for a release candidate:
-* Check directories for unused files, delete:
+* Check directories for unused files. It is easier to keep development and testing separate to avoid many of these files but, in any case, look for and delete:
 ** *.pyc
 ** .DS_Store
 ** *~
 * Update 'doc/MANIFEST' file with the command 'ls -lghR > doc/MANIFEST'
 * Create 'setup/bbp-<VERSION>-md5.txt' file with the md5 sums of all validation and region packages

@@ Line 108: / Line 108: @@
 These are the steps needed for a release candidate:
 * Update 'doc/MANIFEST' file with the command 'ls -lghR > doc/MANIFEST'
 * Create 'setup/bbp-<VERSION>-md5.txt' file with the md5 sums of all validation and region packages

@@ Line 94: / Line 94: @@
 ** Running Tests page needs updated Unit and Acceptance tests' output
 ** Running Simulations page can be revised to reflect output from latest release
 ** Troubleshooting page should be changed to add any known issues with release
 ** Data Products and File Format pages should be updated if release has related changes
@@ Line 106: / Line 108: @@
 These are the steps needed for a release candidate:
+* Update 'doc/MANIFEST' file with the command 'ls -lghR > doc/MANIFEST'
 === Create Final Release ===
 === Release Announcement ===

@@ Line 85: / Line 85: @@
 * Check out local copy of BBP GitHub wiki
 * Update documentation on the Wiki
-** Plots go to the images directory
+** Make sure version is updated on all examples
-** Pdf files go to the pdfs directory
+*** Running Tests and Running Simulations pages
-* Update documentation
+** Introduction page mentions latests release
 === Preparing Release Candidate ===

@@ Line 1: / Line 1: @@
 = Steps For Releasing Broadband Platform =
-These are the steps needed for making a Broadband Platform release.
+There are a number of steps needed for making a Broadband Platform release. The main steps are:
 === Code Freeze ===
-The first step for a BBP release is to collect the latest codes from all science teams. Ideally, each science team will have reviewed their results and signed off on their method before the code freeze. This will avoid surprises and delays later in the release process.
+The first step for a BBP release is to collect the latest codes from all science teams. Ideally, each science team will have reviewed their results and signed off on their method before the code freeze. This should be done to avoid surprises and delays later in the release process.
 * Announce code freeze date
-* Collect code and parameter changes
+* Collect code updates and parameter changes from each group
-* Run simulations as needed
+* Run simulations as needed to validate changes
 ** Single realizations
-*** Useful to make sure codes work
+*** Useful to make sure codes work, saves tmpdata files in case something goes wrong and needs debugging
 ** Cluster testing
 *** Useful to explore different realizations, create validation sets
@@ Line 21: / Line 29: @@
 These are the steps for a science review of the BBP:
-* Make sure cluster has latest versions of everything, use 'diff -r' to make sure source distribution, bbp_gf, and bbp_val are in sync
+* Make sure cluster has latest versions of everything
-* rsync needed packages in bbp_gf to /staging
+** Use 'diff -r' to make sure source distribution, bbp_gf, and bbp_val are in sync
 * Run Part-A and Part-B full validations for each method
-** Can use XXXX_a.sh and XXXX_b.sh scripts (where XXXX is each method)
+** Use XXXX_a.sh and XXXX_b.sh scripts (where XXXX is each method)
-*** Create and submits to cluster all validation events for that method
+*** Creates and submits to cluster all validation events for that method
 * Run Multi-segment Part-A events not included in XXXX_a.sh scripts
-** GP and SDSU Landers is an example, each segment needs to be submitted and then merged with bbp_merge_multisegment_validation.py tool
+** Landers
 * Plot results
-** plot_XXX_a.sh and plot_XXX_b.sh scripts will generate the combined GoF plots automatically
+** plot_part_a_XXX.sh and plot_part_b_XXX.sh scripts will generate the combined GoF plots automatically
 ** combine_map_gof_gen.py and combine_dist_gof_gen.py to generate map and distance GoF plots
 ** Run create_convergence_plots.sh to create convergence plots for the Part-A validation events
@@ Line 43: / Line 54: @@
 **** Tables
 ** Copy Part-A GoFs, Part-B GMPE plots, Map GoFs, Distance GoFs, Convergence Plots to their respective directories