This page is used to track the process and progress of the R2015a release.

Release Lead Roles

Open Process Questions R2015a

• Consider merging to production and test this before next release process
• Automate installer packaging
• Consider sanity check from mission users' scripts
• Feature Freeze/QA Complete/Beta Test must happen earlier (month before code/App Freeze)
  
  • We need to baseline the test results well before release process starts.  Probably at Feature Freeze\QA Freeze
  • Consider allowing GATS to produce multiple reports from one test run
• When should we merge with production and baseline tests?

Release Risks

This is a list of all risks (opened and closed) related to smooth release of R2015a.

Tasks

Git Repo Branching Policy

This is our branching strategy during RC testing by the FDF for ODT.

• We will create a new R2017aTemp branch from master, and developers working on code changes for R2017a would work in R2017aTemp. 
• Those working on docs, app freeze items, and the few remaining code updates for R2016a keep working in master. 
• Code changes for master could continue to require code reading and CCB approval.
• Once we've promoted the RCs to release builds, we'll first branch R2016a from master, then merge R2017aTemp back into master and return to normal branching/commit policy.

Early Tasks

These are long-lead early tasks that can be completed before the detailed release cycle.

Use "(/)" for the checkmark () and "(x)" for the cross ()

Task	Who	Status	Internal Status	Notes
Review Previous Build Release R2015b Process Notes	All
Obtain Release Approvals	SPH			Needed by release day.
Get updated legal statement/license	SPH	N/A		Needed by Code Freeze.
Update sample scripts	SPH			Needed by App Freeze. Write examples that demonstrate new functionality Clean up all errors and warnings Remove deprecated fields
Write draft Release Notes	SPH			Needed by App Freeze. See Writing Release Notes
Update standard descriptive text	SPH			Needed by App Freeze. Will be used in User Guide, websites, release announcement.
Update version number in User Guide cover	SPH			Needed by App Freeze. Contact Katy Gammage or Mary Hrybyk-Keith to update cover page. Next time: integrate sejda-console to do this automatically.
Update info on public-facing websites	TGG			Needed by Release Day. See the list of sites. Update this list as well, if necessary. Updated major sites before announcement. Minor ones can be updated a bit later.
Update release announcement contacts	SPH			Needed by Release Day. Located here.
Put in order for additional icons	SPH			(if necessary) Needed by Visual Freeze.

For QA Complete (July 10)

QA complete means that all known bugs are being tracked, all bug fixes are verified and documented, and the release process can begin.

Use "(/)" for the checkmark () and "(x)" for the cross ()

Task	Who	Status	Notes
Verify that all known bugs are checked into JIRA	(All)	DSC: RQ: SPH:
Complete all JIRA verifications	(All)	DSC: RQ: SPH:
Complete QA wrap-up tasks	DJC, SPH, JJKP, RQ	DSC: RQ: SPH:	JJKP: Need to run save mode one last time before code freeze. DJC: No Wrap-up tasks assigned to me
Address all JIRA tickets awaiting feedback	(All)	DSC: RQ: SPH:
Mark .tc files with requirements and verify traceability to new requirements	(All)	DSC: RQ: SPH:	This is new this year!
Perform Static Analysis	TGG

For Visual Freeze (Aug. 5)

Visual Freeze finalizes all graphical changes to the software, so that screenshots, documentation, and TestComplete can be updated.

Use "(/)" for the checkmark () and "(x)" for the cross ()

Task	Who	Status	Internal Status	Notes
Update About panel	LOJ			Update release number (i.e. R2015a).   Add any new libraries used.  Update an links.
Update splash screen	TGG			Add new contributors Remove contributors who did not contribute to this release Design updates Update SplashScreen.psd in GmatDevelopment\moredata\graphics\splash Use GIMP to save a flattened TIF file and overwrite splash screen in GmatDevelopment\application\data\graphics\splash. Make sure there is a BETA splash as well.
Update icons	TGG	SPH: WCS: TGG:	SPH: WCS: TGG:	If there are any updates, additions, deletions. Including GMATIcon for Welcome Page
Update gmat_startup_file.txt	WCS			Update formatting, comments Add any additional plugins Switch to release configuration (comment out alpha plugins)
Switch to release configuration in script test system	SPH			Create new rundef.R2015aInternal.template.m and rundef.R2015aPublic.template.m. Switch autorun.m to use appropriate one.
Complete visual updates	(All)

For Code Freeze (Aug. 8) 

Code Freeze is a freeze on the software itself before final testing.

Use "(/)" for the checkmark () and "(x)" for the cross ()

Task	Who	Status	Internal Status	Notes
Update EOP files (EOP, PCK, TK)	WCS			Update eopc04_08.62-now and run smoke tests and SPICE .bpc file (SHOULD be moved to App Freeze)
Update tai-utc file & naif LSK	WCS			Update gmat_startup_file with new LSK
Update Info.plist and RunGMAT as needed; also, RunGmat.m if needed	WCS			Need copyright and release number/name at least; Update to default MATLAB version in test system file
Update files w/ updated legal statement	LOJ	N/A	N/A	Readme file Source code files
Update license text	LOJ	N/A	N/A	Update application/License.txt file.  Nothing to do since license did not change.
Update copyright and code headers	LOJ	N/A	N/A	This tool makes adding paragraphs and changing headers simple.  http://sourceforge.net/projects/findandreplace/ As of R2015a these directories have files that need updating. public\src (hpp, cpp) public\plugin (hpp, cpp) public\application\matlab\gmat_keyword (.m) internal\code (hpp,cpp)
Final bug fixes	(All)
Mark all open bugs as Affects: current release	SPH	SPH:
Set release name in code	LOJ	LOJ		Change GmatGlobals to use formal release name

For App Freeze (Oct. 6) 

App Freeze is a freeze on all application bundle files beyond data and code. This includes documentation, sample scripts, stuff in the extras folder, etc.

Use "(/)" for the checkmark () and "(x)" for the cross ()

Task	Who	Status	Notes
Update README.txt	SPH	SPH: WCS: DJC:	Update with major release highlights.
Update extras folder	SPH		Notepad++ syntax coloring file
Update PDF files in docs folder	SPH/DJC	DJC:  SPH:	Update watermark: "Draft for Release R2016a" Put into application/docs folder, and individual doc source folders
Gather list of compatibility changes since last release	SPH		Deprecated fields Removed & disabled fields Anything a user would need to know to make R2016b scripts compatible with this release.
Update Release Notes	SPH
Update screenshots in User Guide	(Feature leads)	SPH:  RQ:  DSC:
Test User Guide instructions & code	(Feature leads)	RQ:  DSC:   SPH:	Tutorials script snippets reference page examples SPH:  only tested features that changed for which I was FDE
Update Windows installer package	TGG
Update links in GMAT.ini	TGG		Help links Welcome page links
Update link tests in TestComplete	TR		Help buttons Welcome Page links Help menu links

Testing of Release Candidate 1 (Oct. 7-14 )

This will start with the 2014-05-05 daily build. Repeat this phase until tests check out. Steve will make the call.

Use "(/)" for the checkmark () and "(x)" for the cross ()

Stage Release (Oct 20)

This is a soft release, putting all the files in place and updating information. Then on release day, we only need to send the announcements.  

Use "(/)" for the checkmark () and "(x)" for the cross ()

Task	Who	Status	Notes
Tag All Repos	DJC		At least tag the test system; consider branching also if the burden on the repo is low.  (In SVN, tagging makes a branch, so tagging already creates a branch.)
Bundle source code	DJC*		Export the trunk code from svn that is used for the release build when that build is started Wait for a go/nogo call from testing on the build Archive the following folder trees into a zip file: src, plugins, build
Bundle data	DJC*		Use the same export as used for the source bundle Wait for a go/nogo call from testing on the build Archive the following folder tree into a zip file: application/data
Upload source bundle to SourceForge	SPH		Move the zip file to SF Mark as "staged" Download the upload and check it
Upload data bundle to SourceForge	SPH		Move the zip file to SF Mark as "staged" Download the upload and check it
Upload Windows installer to SourceForge	SPH		Download, install, and run after uploading.
Upload zip files to SourceForge	SPH		Download and run after uploading.
Post README.rst.txt on SourceForge	SPH		Update for new release
Upload docs to documentation site	SPH		Upload using SSH to http://gmat.sourceforge.net/docs/ Update HTML with new section Move "latest" pointer to new folder SEE NOTES IN SECTION BELOW
Fixed "latest download" to point to new exe.	SPH		See instructions here: http://stackoverflow.com/questions/6777327/how-to-manually-set-the-default-download-file-in-a-sourceforge-project
Post internal & public release files to MESA network	SPH
Upload source to Git repo			Upload src Change new branch to be active branch (what is checked out by default)
Make SourceForge repository backup	SPH		Follow SourceForge's instructions. Here is the Rsync command for us:     rsync -av git.code.sf.net::p/gmat/git.git .

* DJC can only do steps 1-3 here because of contractual constraints

Release Day (Oct.21)

Use "(/)" for the checkmark () and "(x)" for the cross ()

Task	Who	Status	Notes
Make files visible on SourceForge	JJKP		07/21: Made visible at time of posting, as "soft" release.
Send out release announcement	SPH		Mention GSFC in the announcement Don't include large attachments.
Post release announcement on SourceForge	SPH*
Post release announcement on GMAT Blog	JJKP
Mark as released in JIRA	SPH

This needs to be assigned to a different person; DJC cannot post to SF

Post-Release

Use "(/)" for the checkmark ().

Notes for postmortem

Please add your notes to the R2016a Lessons Learned document.

Compatibility changes

See Writing Release Notes

Creating an RC

• Prerequisites:
  • sejda-console
  • nsis (nsis must also be on path)
  • mingw http://www.mingw.org/
  • command line zip

1. Create the build
   1. Log into gs580w-gmat-t4 as "gsfc580gmatbuild". The credentials are on the network drive, in the Infrastructure folder.
   2. Start Task Scheduler.
   3. [RC1 only] Disable the "GMAT Daily Build" task, so it doesn't run automatically during the RC cycle (this can make things overly confusing).
   4. Manually run the "GMAT Daily Build" task.
2. Create the bundles
   1. On your local system, navigate to GmatDevelopment\build\install\windows-nsis. Note that you do not need to pull files down from the Git repository; this process will pull files from the remote build and create the packages in your local directory. There's a README.txt file there that explains things.
   2. Open a MinGW, MSYS2, or Cygwin shell in this directory.
   3. Run 'make assemble VERSION="R2015a-rc#"', where "#" is the number of the RC you're creating. This will create two directories in the current directory: gmat-internal and gmat-public.

   4. Run the following commands to add the User Guide cover. This requires sejda-console.

      sejda-console merge -f ../../../doc/help/src/files/images/Cover-UserGuide-A4-Trimmed.pdf gmat-internal/GMAT/docs/help/help-a4.pdf -o gmat-internal/GMAT/docs/help/help-a4-new.pdf -s all:all:
      mv gmat-internal/GMAT/docs/help/help-a4-new.pdf gmat-internal/GMAT/docs/help/help-a4.pdf
      
      sejda-console merge -f ../../../doc/help/src/files/images/Cover-UserGuide-Letter-Trimmed.pdf gmat-internal/GMAT/docs/help/help-letter.pdf -o gmat-internal/GMAT/docs/help/help-letter-new.pdf -s all:all:
      mv gmat-internal/GMAT/docs/help/help-letter-new.pdf gmat-internal/GMAT/docs/help/help-letter.pdf
      
      sejda-console merge -f ../../../doc/help/src/files/images/Cover-UserGuide-A4-Trimmed.pdf gmat-public/GMAT/docs/help/help-a4.pdf -o gmat-public/GMAT/docs/help/help-a4-new.pdf -s all:all:
      mv gmat-public/GMAT/docs/help/help-a4-new.pdf gmat-public/GMAT/docs/help/help-a4.pdf
      
      sejda-console merge -f ../../../doc/help/src/files/images/Cover-UserGuide-Letter-Trimmed.pdf gmat-public/GMAT/docs/help/help-letter.pdf -o gmat-public/GMAT/docs/help/help-letter-new.pdf -s all:all:
      mv gmat-public/GMAT/docs/help/help-letter-new.pdf gmat-public/GMAT/docs/help/help-letter.pdf
       

   5. Run 'make VERSION="R2015a-rc#"', where "#" is the number of the RC you're creating. This will create four packages in the current directory: A .zip and a .exe file for both the internal and public versions. Note: To create only an internal version, run 'make internal VERSION="R2015a-rc#"'.
   6. Copy the four package files to the network: \\mesa-file\595\GMAT\Builds\windows\VS2013_build_32\R2015a
   7. To clean everything up afterwards, run "make clean".
3. Run the script test system on the internal installer package. See Running the script test system, below.

Note: To make the final release bundles, you can't just rename the files to take off the "-rc#" portion. You need to recreate the bundles using this command: make VERSION="R2015a" 

Running the script test system

In the steps below, "#" is the RC number and "<config>" is "internal" or "public".

1. Log into gs580w-gmat-t4 as "gsfc580gmattest". The credentials are on the network drive, in the Infrastructure folder.
2. [RC1 only] Start Task Scheduler and disable the "Run Script Test" task. You'll need to run the RC tests manually.
3. Uninstall all previous versions of GMAT.
4. Install the version being tested.
   1. Check "Enable MATLAB interface".
   2. Leave "Associate file types" unchecked.
5. Update the test system repo (located at C:\Users\gsfc580gmattest\Documents\GmatTest)
6. In MATLAB (64-bit):
   
   1. Run:
      >> cd C:\Users\gsfc580gmattest\Documents\GmatTest\bin
   2. Run (replace # with RC number and <config> with "internal" or "public"):
      >> diary('..\log\R2015a-rc#-<config>.log')
   3. Run (this command copies application files such as SPICE kernels needed for regression tests into the new installation of GMAT):
      >> preparegmat('C:\Path\To\GMAT')
   4. In C:\Users\testuser\Documents\GmatTest\bin, copy the appropriate template (autorundef.R2015aInternal.template.m or autorundef.R2015aPublic.template.m) to a new name (such as autorundef.R2015aRc1Internal.m) and fill in the values:
      
      1. RunDef.Build: "R2015a-rc#-<config>"
      2. RunDef.GmatExe: path to installed GMAT.exe
      3. RunDef.RegressionBuild: last build date if testing RC1 (look in GmatTest\output for latest folder, such as 2013-07-31), otherwise, "R2015a-rc#-<config>"
   5. Run:
      >> gmattest <name of rundef.m> (e.g. autorundef.R2015aRc1Internal.m) 
   6. Wait until run completes (usually 8+ hours)
   7. Run:
      >> diary('off')
7. In a Windows cmd window, post results to network using robocopy:
   >robocopy "C:\Users\gsfc580gmattest\Documents\GmatTest\output\R2015a-rc#-<config>" "\\mesa-file\595\GMAT\TestResults\win7\R2015a-rc#-<config>" /E /MT /LOG:%TEMP%\robocopy.txt

Updating SourceForge HTML docs page

The Sourceforge page for logging in is here:  https://sourceforge.net/p/forge/documentation/SFTP/

I (SPH) used Filezilla and this was pretty straightforward once succesfully logging in:

Hostname is frs.sourceforge.net

UserName: "YOURSOURCEFORGEUSERNAME,gmat"

Password is: YOURSOURCEFORGEPASSWORD

File Updating

1. Add a new folder for the release under the gmat\htdocs\docs folder
2. Update contents of the new release folder with files from new release
3. Update the gmat\htdocs\docs\index.html to include new folder and to point to the new latest folder.