Mission Control Automation Framework (MCAF)

APPLICATION: MCAF.js

AUTHOR(S): Armond Sarkisian

MAINTAINER(S): Armond Sarkisian

EMAIL: armond.sarkisian@jpl.nasa.gov

GIT BRANCHES: main, dev

DESCRIPTION: The back-bone for MCAS (Mission Control Automation System). This is where all the back-end calls for PyTest and Cypress are stored. This is for Cypress

SPECIFICATIONS:

• Test Framework: Cypress 11.1.0+
• Language: NodeJS 16.13.1+

REQUIREMENTS:

• Cypress - Cypress Client
• GIT - GIT
• Docker - Docker

MCAF.JS: WORKFLOW:

1. Clone MCAF from github.jpl.nasa.gov and navigate into the MCAF directory:

$ git clone git@github.jpl.nasa.gov:MGSS/MCAF.git   # clone project
$ cd MCAF                                           # access repo root

2. Open your favourite IDE (i.e., Visual Studio Code) and open the project inside the ./mcaf.js folder

3. Create your branch and start updating the changes

$ git checkout -b 123-branch-name-goes-here         # create a new development branch

4. Navigate into ./mcaf.js

5. Perform the necessary implementation

6. Run the following commands:

$ yarn pr:prepare
$ yarn doc:prepare

7. Navigate into the Github project folder: https://github.jpl.nasa.gov/MGSS/MCAF/issues/new/choose

8. Create a new release

9. Be sure to follow the steps, update the version, verify the formatting and create a new pull request

10. Ensure you complete the checklist for the PULL REQUEST

11. Once all is done and merged, be sure to update the remote repository:

$ yarn npm:publish

HELPFUL SOFTWARE/EXTENSIONS/PLUGINS:

The following applications/plugins can further aid you in getting the job done effectively and quickly. I especially recommend VIM if you love keyboard shortcuts.