Add commands to analyze and extract procedures #100
Conversation
krollins-mdb
left a comment
krollins-mdb
left a comment
There was a problem hiding this comment.
LGTM with just a couple comments. Would be good to have Cory or Caleb take a closer look.
audit-cli/README.md
Outdated
| - **Hash**: A short 6-character hash of the content (for uniqueness) | ||
|
|
||
| Examples: | ||
| - `before-you-begin-pull-the-mongodb-docker-image-e8eeec.rst` |
There was a problem hiding this comment.
For legibility, could we use underscores between the different pieces of the filename? For example:
before-you-begin_pull-the-mongodb-docker-image_e8eeec.rst
I know that's a little odd convention-wise, but it would improve scanability if we're expecting people to reference the files.
There was a problem hiding this comment.
Whew, this is a large file. Any way we can break it up a bit to improve maintainability?
cbullinger
left a comment
cbullinger
left a comment
There was a problem hiding this comment.
curious to see this in action!
| // generateOutputFilename generates the output filename for a procedure. | ||
| // | ||
| // Format: {heading}-{first-step-title}-{hash}.rst | ||
| // Example: "before-you-begin-pull-the-mongodb-docker-image-a1b2c3.rst" |
There was a problem hiding this comment.
kind of agree with kyle that underscores would improve the readability
| - Sub-procedures (ordered lists within steps) | ||
| - YAML steps files (automatically converted to RST format) | ||
|
|
||
| **Deterministic Parsing:** |
There was a problem hiding this comment.
might be useful to link out to the PROCEDURE_PARSING doc somewhere; i found it answered a few questions that popped in my head as i was reading this README
This PR adds two new commands to the audit-cli:
We can use these commands to scope work and plan testing projects related to procedures. We can also potentially use the parser as a basis for future work related to procedure testing, so I've added extra documentation around the business logic for determining procedure uniqueness, reporting on them, etc.