Skip to content
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 cFS application template. Refs #157. #160

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

ivanperez-keera
Copy link
Member

Adjust ogma-cli and ogma-core to allow customizing the cFS application by using custom-provided templates, as prescribed in the solution proposed for #157.

@ivanperez-keera
Copy link
Member Author

ivanperez-keera commented Nov 14, 2024

Change Manager: The functions fileContents could be renamed, the comment needs to be adjusted, and the haddock for copyTemplate needs to provide more details.

…ion. Refs nasa#157.

The cFS application generation backend has a fixed template that it uses
to generate the cFS application. 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 cfs command to use mustache to
generate the cFS monitoring application template using variable
expansion.
…n. Refs nasa#157.

The cFS application generation backend has a fixed template that it uses
to generate the cFS application. 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 cfs command to accept
an additional argument that points to a user-provided directory with a
custom template.
…irectory to cFS app command. Refs nasa#157.

The cFS application generation backend has a fixed template that it uses
to generate the cFS application. 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.
…ation. Refs nasa#157.

The cFS application generation backend has a fixed template that it uses
to generate the cFS application. 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.
@ivanperez-keera
Copy link
Member Author

Implementor: Updates implemented, review requested.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant