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

docs: adr-001 cli implementation #347

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

gvauter
Copy link
Contributor

@gvauter gvauter commented Sep 17, 2024

Description

Adds ADR for proposed Click CLI and config file implementation.

@gvauter gvauter added enhancement New feature or request breaking_change Backward incompatible changes proposal Issue with a design proposal labels Sep 17, 2024
@gvauter gvauter changed the title docs: ADR-001 CLI implementation docs: adr-001 cli implementation Sep 18, 2024
@gvauter gvauter marked this pull request as ready for review September 18, 2024 17:03
Copy link
Member

@jpower432 jpower432 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, this makes sense to me. A couple questions around the config.

---
x-trestle-template-version: 0.0.1
title: Implement CLI Framework
status: accespted
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
status: accespted
status: accepted

markdown-path-catalog: markdown/catalogs
markdown-path-compdef: markdown/component-definitions
ssp-index-path: ssp-index.json
profile-upstreams: [<url>]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would be to support the sync-upstreams command, correct? I think we could collapse this to a single field given that trestle would import the upstream artifacts into the correct location based on model type.

git-committer-email: [email protected]
models:
# we could allow for multiple or keep this as one
- oscal-model: "ssp"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This configuration would be per model type so I think markdown-path makes more sense here. As well as ssp-index. My line of thinking is if you need to specify a model type on the field, it should go under the model specific configuration. WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking_change Backward incompatible changes enhancement New feature or request proposal Issue with a design proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants