@asarkisian/mcaf.js
v1.0.40
Published
MGSS/MCAF (Mission Control Automation Framework)
Downloads
13
Maintainers
Readme
Mission Control Automation Framework (MCAF)
APPLICATION: MCAF.js
AUTHOR(S): Armond Sarkisian
MAINTAINER(S): Armond Sarkisian
EMAIL: [email protected]
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:
MCAF.JS: WORKFLOW:
- Clone MCAF from github.jpl.nasa.gov and navigate into the MCAF directory:
$ git clone [email protected]:MGSS/MCAF.git # clone project
$ cd MCAF # access repo root
Open your favourite IDE (i.e., Visual Studio Code) and open the project inside the ./mcaf.js folder
Create your branch and start updating the changes
$ git checkout -b 123-branch-name-goes-here # create a new development branch
Navigate into ./mcaf.js
Perform the necessary implementation
Run the following commands:
$ yarn pr:prepare
$ yarn doc:prepare
Navigate into the Github project folder: https://github.jpl.nasa.gov/MGSS/MCAF/issues/new/choose
Create a new release
Be sure to follow the steps, update the version, verify the formatting and create a new pull request
Ensure you complete the checklist for the PULL REQUEST
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.
| PLUGIN | README | | ------------------------- | --------------------------------------------------------------------------------------------------- | | VIM | [https://www.vim.org/] | | TMUX | [https://github.com/tmux/tmux/wiki] | | Vundle Plugin | [https://github.com/VundleVim/Vundle.vim] | | Firebug Plugin | [https://blog.getfirebug.com/] | | Firepath Plugin | [https://firepath.en.downloadastro.com/] | | Omnibug Plugin | [https://chrome.google.com/webstore/detail/omnibug/bknpehncffejahipecakbfkomebjmokl?hl=en] | | JSON Viewer Plugin | [https://chrome.google.com/webstore/detail/json-viewer/gbmdgpbipfallnflgajpaliibnhdgobh?hl=en-US] | | JSON/YAML Toggle Plugin | [https://chrome.google.com/webstore/detail/json-yaml-toggle/dphedhpnbojdegjcokghhfploeobobbc?hl=en] | | iTerm2 Terminal (for Mac) | [https://www.iterm2.com/] | | Cygwin Terminal (for Win) | [https://www.cygwin.com/] |