-
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 standalone application template. Refs #189.
#191
Merged
ivanperez-keera
merged 8 commits into
nasa:develop
from
ivanperez-keera:develop-standalone-templates
Dec 24, 2024
Merged
ogma-cli
: Allow customizing the standalone application template. Refs #189.
#191
ivanperez-keera
merged 8 commits into
nasa:develop
from
ivanperez-keera:develop-standalone-templates
Dec 24, 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
ivanperez-keera
force-pushed
the
develop-standalone-templates
branch
from
December 24, 2024 06:06
47a477c
to
7748292
Compare
Change Manager: The comments of the |
…pplication. Refs nasa#189. The standalone backend uses a fixed template to generate the Copilot monitor. 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), or not using ogma altogether for that reason. This commit modifies the ogma-core standalone command to use mustache to generate the Copilot monitor via a template and variable expansion. We introduce a new template that uses variables, and we modify the cabal file to include the files that make up the default template as data files that are copied over during installation. To be able to generate the files, we need to introduce a target directory option for the standalone command.
…mand. Refs nasa#189. The standalone backend uses a fixed template to generate the Copilot monitor. 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), or not using ogma altogether for that reason. A prior commit introduced, in the standalone command, support for custom templates. Unlike the prior implementation of the standalone command, which printed the output to standard output, the new interface puts the result in a file (or several files) included with the template. To implement this new functionality, we have added an argument to specify a target directory for the generated standalone application, where the files will be copied to. This commit modifies the tests for the standalone command to provide a temporary directory as destination. We default to the temporary directory of the host system. Since this is only used for testing and not during normal operation, and the ogma implementation is open source, we consider this safe from a security standpoint.
…ory. Refs nasa#189. The standalone backend uses a fixed template to generate the Copilot monitor. 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), or not using ogma altogether for that reason. A prior commit introduced, in the standalone command, support for custom templates. Unlike the prior implementation of the standalone command, which printed the output to standard output, the new interface puts the result in a file (or several files) included with the template. To implement this new functionality, we have added an argument to specify a target directory for the generated standalone application, where the files will be copied to. This commit exposes that new parameter to set the target directory to the user in the CLI.
…d. Refs nasa#189. The standalone backend uses a fixed template to generate the Copilot monitor. 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), or not using ogma altogether for that reason. A prior commit introduced, in the standalone command, the ability to use mustache to expand variables in a template. This commit modifies the standalone command to accept an additional argument that points to a user-provided directory with a custom template.
…ommand. Refs nasa#189. The standalone backend uses a fixed template to generate the Copilot monitor. 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), or not using ogma altogether for that reason. A prior commit introduced, in the standalone command, support for custom templates and, with it, the ability to pass a custom directory containing a standalone application template. This commit modifies the tests for the standalone command to provide no custom template directory, to use the default included with Ogma.
…plate source directory. Refs nasa#189. The standalone backend uses a fixed template to generate the Copilot monitor. 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 template and expand variables using mustache. This commit exposes that new parameter to the user in the CLI.
ivanperez-keera
force-pushed
the
develop-standalone-templates
branch
from
December 24, 2024 15:12
7748292
to
9c76554
Compare
Implementor: Fix implemented, review requested. |
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 standalone Copilot monitoring application by using custom-provided templates, as prescribed in the solution proposed for #189.Unlike in the solution proposed for #189, the README is not modified to explain how to use this feature, since there is no section in the current README explaining how the standalone command works.