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 standalone application template #189

Open
ivanperez-keera opened this issue Dec 6, 2024 · 3 comments
Open
Assignees
Labels
CR:Status:Implementation Admin only: Change request that is currently being implemented CR:Type:Feature Admin only: Change request pertaining to new features requested
Milestone

Comments

@ivanperez-keera
Copy link
Member

Description

The standalone application generation backend uses a fixed template to generate the standalone 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.

Allowing users to pick their own standalone template would make Ogma more versatile.

Type

  • Feature: Enable customizing output produced.

Additional context

None.

Requester

  • Ivan Perez.

Method to check presence of bug

Not applicable (not a bug).

Expected result

Ogma allows users to pick the custom standalone application template they want to use instead of relying on the one provided by default.

Desired result

Ogma allows users to pick the custom standalone application template they want to use instead of relying on the one provided by default.

Proposed solution

Modify ogma-core to use variable expansion based on mustache to create the output files.

Modify ogma-core's template to use the variables used by the standalone application generation module.

Modify ogma-core to give users the ability to pick a template directory via an optional input argument.

Modify ogma-cli to give users the ability to pick a template directory via an optional input argument (exposing the corresponding argument from ogma-core).

Modify README to demonstrate new capability.

Further notes

None.

@ivanperez-keera ivanperez-keera added CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Feature Admin only: Change request pertaining to new features requested labels Dec 6, 2024
@ivanperez-keera
Copy link
Member Author

Change Manager: Confirmed that the issue exists.

@ivanperez-keera ivanperez-keera added CR:Status:Confirmed Admin only: Change request that has been acknowledged by the change manager and removed CR:Status:Initiated Admin only: Change request that has been initiated labels Dec 10, 2024
@ivanperez-keera
Copy link
Member Author

Technical Lead: Confirmed that the issue should be addressed.

@ivanperez-keera ivanperez-keera added CR:Status:Accepted Admin only: Change request accepted by technical lead and removed CR:Status:Confirmed Admin only: Change request that has been acknowledged by the change manager labels Dec 10, 2024
@ivanperez-keera
Copy link
Member Author

Technical Lead: Issue scheduled for fixing in Ogma 1.6.0.

Fix assigned to: @ivanperez-keera .

@ivanperez-keera ivanperez-keera added CR:Status:Scheduled Admin only: Change requested scheduled and removed CR:Status:Accepted Admin only: Change request accepted by technical lead labels Dec 10, 2024
@ivanperez-keera ivanperez-keera added this to the 1.6.0 milestone Dec 10, 2024
@ivanperez-keera ivanperez-keera self-assigned this Dec 10, 2024
@ivanperez-keera ivanperez-keera added CR:Status:Implementation Admin only: Change request that is currently being implemented and removed CR:Status:Scheduled Admin only: Change requested scheduled labels Dec 11, 2024
ivanperez-keera added a commit to ivanperez-keera/ogma that referenced this issue Dec 11, 2024
…omponent. Refs nasa#189.

The standlone 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.

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 new files 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.
ivanperez-keera added a commit to ivanperez-keera/ogma that referenced this issue Dec 11, 2024
ivanperez-keera added a commit to ivanperez-keera/ogma that referenced this issue Dec 11, 2024
…omponent. Refs nasa#189.

The standlone 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.

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 new files 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.
ivanperez-keera added a commit to ivanperez-keera/ogma that referenced this issue Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR:Status:Implementation Admin only: Change request that is currently being implemented CR:Type:Feature Admin only: Change request pertaining to new features requested
Projects
None yet
Development

No branches or pull requests

1 participant