feat: adds markdown generation to the rules transform entrypoint #282
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BREAKING CHANGE: Modifies the existing behavior of the rules transform entrypoint Signed-off-by: Jennifer Power <[email protected]>
|
@gvauter This code is not completely ready yet, but looking for early feedback. |
Signed-off-by: Jennifer Power <[email protected]>
Logging the traceback string in debug mode helps with development without displaying to users by default. Signed-off-by: Jennifer Power <[email protected]>
Signed-off-by: Jennifer Power <[email protected]>
Signed-off-by: Jennifer Power <[email protected]>
Signed-off-by: Jennifer Power <[email protected]>
gvauter
approved these changes
Jul 26, 2024
| @@ -278,10 +278,13 @@ def __init__(self, arg: str, msg: str): | |||
|
|
|||
|
|
|||
| def handle_exception( | |||
| exception: Exception, msg: str = "Exception occurred during execution" | |||
| exception: Exception, | |||
| traceback_str: str, | |||
There was a problem hiding this comment.
Should we make this an optional kwarg in case someone doesn't implement traceback in their code and only sends the exception?
There was a problem hiding this comment.
Thanks for the suggestion!
There was a problem hiding this comment.
@gvauter Ask discussed, will merge this as is and we can look at other options for exception handling down the road.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change alters the way
rules-transformworks currently. Instead of ending the workspace management tasks with OSCAL changes, it ends with Markdown changes. A broader approach necessary for therules-transformaction to be useful on its own because the source of truth for authored model content is Markdown.handle_exceptionin separate commit (needed for debugging tests for this PR)Fixes #226
Follow On
Not required but there are a lot of flag options here that would be relatively static (e.g.
markdown_path) that are used in multiple places. It might be worth exploring using a configuration file for inputs that cannot be automatically populate or do have defaults.Type of change
How has this been tested?
Checklist