-
Notifications
You must be signed in to change notification settings - Fork 26
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
ogma-cli
: Allow customizing the F' component template. Refs #185.
#188
Merged
ivanperez-keera
merged 8 commits into
nasa:develop
from
ivanperez-keera:develop-fprime-templates
Dec 6, 2024
Merged
ogma-cli
: Allow customizing the F' component template. Refs #185.
#188
ivanperez-keera
merged 8 commits into
nasa:develop
from
ivanperez-keera:develop-fprime-templates
Dec 6, 2024
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
…. Refs nasa#185. The F' backend uses a fixed template to generate the F' component. That template does not fit all use cases, so we are finding users heavily modifying the output (which is hard to keep up with when there are changes), and or not using ogma altogether for that reason. This commit modifies the ogma-core fprime command to use mustache to generate the F' monitoring application via a template and variable expansion. We adapt the template to also use those variables, and we modify the cabal file to include the new files as data files that are copied over during installation.
…ration. Refs nasa#185. The F' backend uses a fixed template to generate the F' component. That template does not fit all use cases, so we are finding users heavily modifying the output (which is hard to keep up with when there are changes), and or not using ogma altogether for that reason. A recent commit introduced the ability to use mustache to expand variables in a template. This commit modifies the fprime command to accept an additional argument that points to a user-provided directory with a custom template.
…irectory to F' app command. Refs nasa#185. The F' backend uses a fixed template to generate the F' component. That template does not fit all use cases, so we are finding users heavily modifying the output (which is hard to keep up with when there are changes), and or not using ogma altogether for that reason. A recent commit introduced into ogma-core the ability to use a custom provided template and expand variables using mustache. This commit exposes that new parameter to the user in the CLI.
…on. Refs nasa#185. The F' backend uses a fixed template to generate the F' component. That template does not fit all use cases, so we are finding users heavily modifying the output (which is hard to keep up with when there are changes), and or not using ogma altogether for that reason. Prior commits have expanded the command to allow for customization of the template using a user-provided directory and expanding variables in the template using mustache. This commit documents the new feature in the README.
The functions copyDirectoryRecursive and copyFile' are no longer needed, now that all parts of ogma-core use the template expansion system. This commit deprecates both functions so that they can be removed in a future version of ogma-extra.
Change Manager: Verified that:
|
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.
Adjust
ogma-cli
andogma-core
to allow customizing the F' monitoring component by using custom-provided templates, as prescribed in the solution proposed for #185 .