Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page is used to track the process and progress of the GMAT R2022a Release.

...

TaskWhoStatusInstructions
Obtain Release AuthorizationBCM

(tick) 09/27/22: Submitted NTR for Contributor Review

(tick) 10/11/22: Submitted Updated NTR into e-NTR

(tick) 10/24/22: Submitted in SRS, pending Patent Counsel Approval


Update and Submit New Technology Report (NTR) via E-NTR System (https://invention.nasa.gov/)

  • DSC: update content section of NTR (start with R2022a Beta NTR) for team review 
  • Innovator Review is 10 days (to review/submit comments), then can submit in SW Release System.

Update and Submit SW Release Package via SRS (https://softwarerelease.ndc.nasa.gov/)

  • Software Release System (SRS) routes package through multiple reviews: 
    • POC Review
    • Initial SRA Review
    • Technology Transfer Office Review
    • Patent Counsel Office Review
    • IT Security Review
    • Export Control Office Review
    • Section 508 Coordinator Office Review
    • Other Review
    • Final SRA Review
    • 1/24/23:  Open source Apache 2.0 approved
Update Sample Scripts
Area Leads

(tick)


11/20/22:  Biggest missing item are the TLE writer sample scripts.  


BCM Action assigned 9/15/22:  work with team to verify:

(1)  all old sample scripts work.  (Remember trick to run all scripts in a folder.  Need Run_Mode=Testing).  Look at all error and warning messages and make sure they are expected.  Need to do main Samples directory and every folder in the Samples directory.  Label new samples with starting prefix, Ex_R2022a_

  • Assigning this to JudeN

(2)  Decide which new R2022a features need sample scripts and add them to the samples directory. 

  • 09/22/22: BCM to generate R2022a Sample Script Spreadsheet to track new features and associated Sample Script name.  Sent to Feature POCs to populate spreadsheet.
  • 09/26/22: reminded Feature POCs to look at spreadsheet

============================

This includes

-Ask SES if he think any more sample scripts needed.  

-Generic GOES sample scripts.  (Dont use GOES orbit or other data, generic torque recall, etc).

Jairus (Ground station masking, cov prop, IOD, TLE prop, Trk 2-23)

Steve S/Pete C (SAA sample script)

Above work ties in with the Release Notes.  (Review list above again after Release Notes written).  


Needed by App Freeze.

  • Write examples that demonstrate new functionality
  • Clean up all errors and warnings
  • Remove deprecated fields
  • Make sure all the old and new sample scripts run correctly.  (Note: There is a way to run all scrips in a folder, must be in Run_Mode=Testing)

Notes/Questions:  

  1. The OFI scripts are stored in the OFI repo, not in the GMAT repo. That's because OFI is an externally maintained and managed project.When GMAT is built, e.g. the windows build machine, it copies the OFI sample scripts into latestcompleteversion. That's how those scripts will be part of the release without being in the GMAT repo.
  2. The sample script file names be pre-pended with R2022a_
  3. Make sure all the API Folder (and associated sub-folder) sample scripts are updated and run correctly.
  4. Starting with R2021a:  For Nav, we will be adding python analysis scripts associated with the EKFS GPS point solution tutorial, to the GMAT releases.  Thus, in addition to the usual GMAT sample scripts, we should be making sure that the non-GMAT scripts, such as these python analysis scripts, also still run correctly. 
Write draft Release NotesDSC/All(tick)

Needed by App Freeze.


See Writing Release Notes

Update version number in User Guide cover
BCMSee Visual Freeze status

Needed by Visual Freeze; see details below.

10/04/22: Katy Comber/279 to update cover page.

    01/2024 New process to submit graphic requests:  open ticket via https://etd-support.ndc.nasa.gov/servicePortal

Next time: integrate sejda-console to do this automatically.

Get updated splash screen
BCMSee Visual Freeze status

Needed by Visual Freeze; see details below.

10/04/22: Contacted Katy Comber/279 to update cover page.





Put in order for additional iconsBCM(tick)

11/10/22;  No additional icons needed.  

Needed by Visual Freeze

None needed since not actively updating GUI.  

Update info on public-facing websitesDSC/DJC(tick)

Needed by Release Day.  Completed 1/26/2023.

See the list of sites. Update this list as well, if necessary.

Update release announcement contactsDSC(tick)

Needed by Release Day.  Located here.  Completed 1/26/2023.

(aerospace professors, ESA, chief technologists at NASA centers)





...

TaskWhoStatusNotes
Write, run, and commit all final test cases.All

DSC:  (tick)

Nav/SES: (tick)

MS: (tick)

PC:  (tick)

JE: (tick)

DJC:  (tick)


11/10/22:  need to test the three bug fixes related to the paths.  SES to test if he can.  Otherwise, Jairus will test.  

11/10/22:  SES and PC to test GMT-7861

After test complete, the test repo is frozen.  All tests must be written by this deadline.



Verify that all known bugs are checked into JIRA(All)

DSC:  (tick)

Nav/SES: (tick)

MS: (tick)

PC:  (tick)

JE: (tick)

DJC:  (tick)

11/10/22:  Jairus to put in a ticket about the TLE writers.  (tick)
Complete all JIRA verifications(All)
Perform independent verification that bug fixes address issue and if necessary create test. 
Test Freeze wrap-up tasksDJC, SPH, SES


See here: Wrap Up Testing - GMAT Wiki - Confluence (atlassian.net)

Work with Steve S on this.  

SES; Submitted ticket GMT-7172 on Save mode issues.  10/13/22 - left here as an example issue.  

 SES added Save category to various tests for each new feature


Notes from R2020a:

RM: Performed manual GUI Delete & Rename tests on OFI  (Ask Ravi to take a look for R2022a)

Address all JIRA tickets awaiting feedback(All)


If someone is asking for clarification, provide requested information.
Mark .tc files with requirements and verify traceability to new requirements(All)

PC: (tick)

update google docs req spec (tick), update TC files (tick), verify RTTM is good (tick)



Req spec: https://docs.google.com/spreadsheets/d/1X0esKqU-OcbgnI0mIj15cUQSA2g66f_anj50ftEYQJQ/edit?pref=2&pli=1#gid=1

RTTM: On mesa in nightly test results

Perform Static AnalysisPC

PC: (tick)

Run VS analysis tool to identify possible issues.  (Note that the requirement here is just to "run" the tool.  Analysis can come later.)

Tool was run and analysis was done by Peter Candell on 9/20/2022

Review all and resolve test failures on each OS (Windows, Linux, Mac)PCPC: (tick)

Windows nearly complete, most work remaining on Mac and Linux

11/10/22:  Ravi and Alex to look at Mac regression test failures.  

11/22/2022:  Steve S to also to take a look at failed Mac regression tests.  

11/28/2022:  For LInux, in addition to the usual Centos7/RHEL7 and Ubuntu test runs, for R2022a, we need additional RHEL8 test runs.  

Review all deferred tests to verify that they are OK to defer.  PCPC: (tick)Look at the daily test results for all 3 o/s.  Do a final review right before Test Freeze achieved.   
Review tests that are not being run to verify that they are OK not to runPCPC: (tick)Create a list of tests not being run nightly.  (e.g., for R2022a, this may be tests with the R2023a category).  Verify that it is OK to not run them.  Do a final review right before Test Freeze achieved.   

...

TaskWhoStatusNotes

Update Info.plist (Mac specific) and RunGMAT (shell script on Mac) as needed

JHE(tick)

Need copyright and release number/name at least - Info_GMAT.plist and RunGMAT

JHE: Updated on 10/21/22

Update test system RunGmat.m on Mac if needed

Mac: RM/AC


Linux: DJC

Mac: (tick)


Linux: (tick)

Update for MATLAB version (MatLab R2022) and Python version (Python 3.9) as needed. This refers to the files in the SVN test repo, found under bin/+gmatrunner/

DJC updated linux files on 9/06/22


This should be before the Freezes-move there for the next release.

Address issues in Static Analysis results(All)(tick)

Pete C. Ran on 9/20/22, need to review results and work fixes

Pete, Tuan, and Jairus each reviewed independently 

Update license text

JHE: Overall

RM: OFI

JHE: (tick)

RM: (tick)

Update application/License.txt file.  May be nothing to do if license did not change.

JHE: No changes to license.txt needed

RM: OFI has no license changes. Still Apache 2 and all dependencies are the same

Check the compilation output and fix selected warning messages.

Windows: PC, JE, TN

Linux: DJC

Mac: JG, RM/AC

Windows: (tick)

Linux: (tick)

Mac: (tick)

Mostly related to the number of Windows warnings, but a check should be done for each OS.

Reviewed and fixed relevant warnings on Windows.

RM: Updated CMake to hide Mac compile warnings related to external components (e.g. Boost)

Mark all open significant bugs as Affects: current release

CCB

(DSC)

(tick)in JIRA, mark all open tickets as affects the current release.  This can be done via a global change.  This is not a huge number of bugs.  
Update version number in CmakelistsJHE(tick)

Do this right before code freeze.  Change from R2020a to R2022a.  

Pushed 11/10/22

Set release name in codeJHE(tick)

Change GmatGlobals to use formal release name

Changed by AC on 11/7/22 as part of splash screen upgrade

Run Dynamic Analysis tool or other tool that checks for memory leaks

DJC

JE

DJC: (tick)

JE:  (tick)

Note that the requirement here is just to "run" the tool.  Analysis can come later.  
11/23/22:  Run on several components; likely to check more

Note: This involves running the Valgrind tool

Update copyright and code headers w/ legal statement

DJC

(All)

DJC:  (tick)

JHE:  (tick)

Note: this must be done after CCB has accepted all final changes and we are ready to create RC1.  It requires coordination with the entire team as almost all source code files will be changed. 

This tool makes adding paragraphs and changing headers simple.  http://sourceforge.net/projects/findandreplace/

DJC:  Done for R2022a.  JHE has 10 files to update

OLD R2020a Notes below:

As of R2020a these directories have files that need updating.

  • public\src (hpp, cpp)
  • public\plugin (hpp, cpp)
  • public/plugin/CInterfacePlugin/matlab
  • public\application\matlab\
  • internal\code (hpp,cpp)
  • Readme file

(star)  Updates for 2011 onwards were needed.  Files that assert copyright outside of the GMAT project were not updated.  Files with no copyright header at all were also not caught (there are at lest some - in the CsaltCWrapper code.  THere is likely more as well.


For R2020a, replace to

// Copyright (c) 2002 - 2018

RM: Updated for OFI


...

TaskWhoStatusNotes
Update Release Notes
DSCN/A

Next time: this should probably be "Update Release Notes" to add outstanding bugs, etc. – title changed 12/18/17 - MES

https://docs.google.com/document/d/1Uy2ZlKLUBPNBdySQPLI-rmibcmRRqX1T8BbPqSsZ8Hg/edit#

Create Windows BuildPC(tick)RC1: 12/12/2022
provide Help folder to Mac/Linux developers

PC



DJC

(tick)



(tick)

This needs to be provided once the documentation is complete and built with the release candidate.  Note this cannot be done until all docs are frozen!   (SPH takes Windows RC, edits Help doc in Acrobat.  Sends to Mac/Linux)


Rebuild the OC/API HTML Help

PC 2022a help folder on mesa file and SharePoint. Ask PC for location. 

Old R2020a Notes below:

DJC: Make sure SPHINX for API and OC are included.   DJC added the files to application/docs. 

Note: For future releases, we should consider adding a build step to generate these automatically as part of the install process in CMake, rather than putting the generated files into the repo directly.

Bundle Windows zip

PC(tick)

Is there anything to this besides putting the build in a zip? Steps for Mac/Linux here too?


For Windows, see gmat\build\install\windows-nsis\CreateInstall.bat

To be placed on Mesa-files

Run TestComplete smoke testsTR(tick)

These are tests on the packaged versions of GMAT:  the zip bundle.  ( Test internal first. )

(Current smoke tests take a long time, about 4 hours.  Maybe later, cut this time down)

Run TestComplete system test missionsTR(tick)These are tests on the packaged versions of GMAT:  the zip bundle from Internal and External packages. 
Run script test system

DSC/JHE/PC

AC/RM/JG

DJC


(tick)

(tick)

(tick)

This must be done on all operating systems that will be released. 

1/11/23:  Alex to create DMG file.  Then install using the DMG file and run test system.  

For 2022a ensure this is done on RHEL7 and RHEL8.  

Windows. Run tests on the internal .zip bundle first, then the external tests afterwards on same build to compare.

For Windows, use task scheduler to turn off the automatic runs.  Then, manually, run the four test scripts below.

To Do:  For Linux/Mac, decide which scripts, analogous to the ones above, need to be run.

(On Final RC, this is 2 runs, internal and external).  Test internal first. 

DSC to check with PC and/or JE on scripts run.  

11/28/2022:  For LInux, in addition to the usual Centos7/RHEL7 and Ubuntu test runs, for R2022a, we need additional RHEL8 test runs.  



Old R2020a Notes below: 

For R2020a Windows results, see \\mesa-file\595\GMAT\Builds\windows\VS2017_build_64\R2020a\RC2\Test Results folder.   

First run tests on the installer version of GMAT. 

(On Final RC, this is 4 runs, Windows and Installer for both  internal and external).  Test internal first. 


Mac – RC1 run completed with 3 errors (alpha off), RC2 run is looping through comparators at 1:46 pm 4/30

Linux – RC2 internal is solid on both Linux flavors.


Test all sample scripts (non-API)

JN/PC/EB

JG/MS/AC

DJC/JR/JHE

(tick)

(tick)

(tick)

At a minimum these need to be run individually by hand or run in GUI regression system.  Additionally, they must be run on a system that has no other installations of GMAT.  Past experience has shown that missing files, and configuration issues are not caught by running on machines used for development.



Test API Sample Scripts

AC/PC/EB

DJC

AC/RM/JG/MS

(tick)

(tick)

(tick)

Windows

Linux, /3/23 Action for DJC

Mac,  1/3/23 Action for AC.  


Old R2020a Notes below: 

Notes: 

(1)  Make sure all API Sample tests (API folder and API/Jupyter sub-folder) run correctly.  

(2)  For 2020a Mac, will not run API sample scripts.  


Definition:  Run scripts in Folder API and API/Jupyter.  

Test all non-GMAT (i.e., not the *.script GMAT scripts) scripts/scenarios.  (new entry for R2021a)

SES



BM/NH

(tick)



(tick)

 Tested utilities/python/Navigation scripts; made some updates. It would be good to get someone to test plot_raw_residuals.py This worked in my python39 environment but failed in my base

Anaconda environment.  1/3/23:  Jairus to test SES mentions.  SES:  why did it fail in Anaconda?

11/10/22:  Make sure all the non OC utilities in utilities\python still work.

Barb to work with NH to make sure all the OC utilities still run correctly in R2022a.  


Note:  Starting with R2021a:  For Nav, we will be adding python analysis scripts associated with the EKFS GPS point solution tutorial, to the GMAT releases.  Thus, in addition to the usual GMAT sample scripts, we should be making sure that the non-GMAT scripts, such as these python analysis scripts, also still run correctly. 

Run TestComplete full regression testsTR(tick)

(For final RC only)

On Final RC, this is 2 runs, Windows both internal and external. 

Have selected users try out the RCDSC(tick)

1/12/23:  After SWFO gives the OK on RC3, then OK.  1/19/23:  Got OK from SWFO.  


Have Khashy, RST, others take the RC for a test drive and report issues.  2022a-RC1: Passed to various users 12/12/2022

Document the RC testing processAll(tick)

Save artifacts related to RC testing.  This includes matlab test scripts used and test results.  For an R2020a example, see \\mesa-file\595\GMAT\Builds\windows\VS2017_build_64\R2020a 

For R2022a, folder \\mesa-file\595\GMAT\Builds\windows\VS2017_build_64\R2022a has been created.  

Barb working this also.  

Create Mac bundlesRavi/Jairus/Alex(tick)

Remaining Steps as of 1/3/23

  • Alex/Jairus to get python 3.6 installed on build machine.  (Submit new ticket and/or work with Mike S on old ticket as needed)
  • Alex/Ravi/Jairus:  Verify that all internal vs. Public issues are ironed out.
    • Send both versions to DJC for a sanity check.
    • Have Ravi finish review.  
    • Place relevant files into \\mesa-file\595\GMAT\Builds\R2022a_ReleaseCandidates 

...

TaskWhoStatusNotes

Make files visible (i.e., unstaging) on SourceForge

DSC(tick)

Completed 1/26/23.  



Old R2020a Notes below:

07/21: Made visible at time of posting, as "soft" release.

(For R2020a, we forgot the "staged" step)

Send out release announcement (Snd BCC to avoid "Reply All" spam)






Create R2022a "Release Notes" PDF to send out. 

DSC







DSC/DJC

(tick)







(tick)

  • Mention GSFC in the announcement
  • Don't include large attachments.







Completed 1/25/23.  


Old R2020a Notes below:

Notes 8/5/2020: 

  1. Sent email to Sourceforge gmat-info email list but received "this list is for project announcements only, so your message has been blocked" response. 
  2. Sent email to Sourceforge gmat-users email list.  Needs Moderator approval.  DJC approved.  Message sent. 
  3. Asked Paul M. to send Release announcement to 590-all. 


"Release Notes" was a bit of a hack.  I made a custom Makefile to build a draft document from the UG xml file, and then edited it for formatting and broken User Guide links.  The cover page is the R2018a cover page, with the "20" piece copied over the 18 and then the "a" shifted to the right.  This is not a recommended best practice! 

Suggestions:

  • Build the text version first and then paste and edit it into the xml, avoiding the internal link issue
  • Make the cover page image document available for editing.  (I suspect it's a Photoshop .psd file with layers.  Or should be.)
Post release announcement on SourceForgeDSC(tick)

Completed 1/26/23.  


At the GMAT Sourceforge website, select the "Admin" section.  Then choose the "Metadata" section.  Make sure to unlock the padlock in the upper right hand.  Update the "Full Description" section and hit "Save."

Post release announcement on Atlassian.  DSC(tick)

Completed 1/26/23.  

Go to https://gmat.atlassian.net/wiki/spaces/GW/overview.  Hit the ". . ." button.  View Restrictions to  make sure you have edit privileges. 

Mark as released in JIRASPH/DSC(error)

2/2/23.  Requires more investigation.  



Old R2020a Notes below:


2/2/23.  We "released" R202a.  See link below.  

https://gmat.atlassian.net/projects/GMT?selectedItem=com.atlassian.jira.jira-projects-plugin%3Arelease-page

R2020a:  Not quite sure what is involved.  Will coordinate with SPH.

8/6/2020:  WIki changed.  SPH to investigate.  Need to find list of releases.

Go to JIRA.  Select "Projects" on LHS menu.  Then select "Releases."  Hit ...

Click on Release of interest.  Move unresolved issues to next Release. 


Update "News" at SourceForgeDSC(tick)

Completed 1/26/23.  

Added release announcement text here as well. 

...