propose_saga
Generate a YAML Saga descriptor for a directory from its dependency files, infrastructure code, and Dockerfiles without writing anything, so users can review the proposal and decide where to save it.
Instructions
Return the Saga descriptor draugr init would write for a directory, as YAML, with the controls its dependency files, infrastructure code and Dockerfiles call for. Call this when a project has no descriptor, before writing one from get_saga_schema. It writes nothing; show the proposal to the user, who decides whether and where to save it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | the directory to propose a descriptor for, absolute or relative to the directory the server was started in; defaults to that directory | |
| perDirectory | No | one component per directory that holds its own dependency file, and a root component for the rest of the tree |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| path | Yes | the file to save the descriptor as; its repository URLs are relative to this directory | |
| saga | Yes | the descriptor draugr init would write for this directory, as YAML, with a comment naming the files behind each scanner it enables | |
| warning | No | ||
| controls | No | ||
| existing | No | descriptors already in this directory; the project's committed scope, which this proposal does not replace | |
| components | No |