-
Notifications
You must be signed in to change notification settings - Fork 3
Create mermaid flowchart in new extractors/README.md
#168
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create mermaid flowchart in new extractors/README.md
#168
Conversation
Adds a mermaid (markdown-formatted) flowchart to show the flow of execution for the current (shell-script-based) extractor implementation. Updates the root `.gitignore` file for this project and adds: - `extractors/.gitignore` - 'javascript/frameworks/cap/test/.gitignore'
lcartey
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of comments, but I think it's great to have this.
We should also note that this flowchart is for calling pre-finalize.sh manually. If you integrate the script into your CodeQL distribution, there will be a slightly different flow.
| SPF ==> |run the cds extractor| DIDX | ||
| JSE -.-> |extract javascript files:<br>_.html, .js, .json, .ts_| DB | ||
| DTRAC ==> |run the build --command| SPF | ||
| JSE ==> |run autobuild within<br>the javascript extractor| DTRAC |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the autobuilder extracts the JavaScript files. The pre-finalize.sh is not run by the autobuilder, so I think this node is in the wrong place.
Adds the `extractors/README.md` file as an evolution of, and a replace ment for, PR advanced-security#168 from this `advanced-security/codeql-sap-js` repository. Updates the CDS tools documentation to reflect progress in the multi-stage process of rewriting the CDS extractor to be more maintainable (WIP) and performant (TODO).
|
Closing this PR in favor of PR #188 . |
Adds a mermaid (markdown-formatted) flowchart to visually document the flow of execution for the current (shell-script-based) extractor implementation.
Also, updates the root
.gitignorefile for this project and adds new files at:extractors/.gitignorejavascript/frameworks/cap/test/.gitignore