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

ZEP-0006 introduce zarf package preview #7

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

Conversation

AustinAbro321
Copy link
Contributor

@AustinAbro321 AustinAbro321 commented Dec 2, 2024

  • One-line PR description: Begins the ZEP to introduce zarf package preview

Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321 AustinAbro321 marked this pull request as draft December 2, 2024 21:52
Signed-off-by: Austin Abro <[email protected]>
Copy link

@mkcp mkcp left a comment

Choose a reason for hiding this comment

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

Good zep, added some feedback

6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
6-manifest-preview-capability/README.md Outdated Show resolved Hide resolved
@phillebaba
Copy link
Member

Just to make this clear. The command will be run on a package directory and not a already created package right?

Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321
Copy link
Contributor Author

@phillebaba yes zarf package preview would run in a package directory

Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
@AustinAbro321 AustinAbro321 marked this pull request as ready for review December 4, 2024 16:48
Signed-off-by: Austin Abro <[email protected]>

Users need an easier way to view what their zarf.yaml will look like after they're rendered by Zarf before `zarf package create`. A rendered zarf.yaml has had templating, imports, and flavors applied.

This will be accomplished through a new CLI command - `zarf package preview`
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not zarf package create --dry-run or something similar? I don't see that being evaluated in the alternatives section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great idea. I did not think of it. That would provide the UX I'm looking for and be more in line with other tools

6-package-preview/README.md Outdated Show resolved Hide resolved
6-package-preview/README.md Outdated Show resolved Hide resolved
6-package-preview/README.md Outdated Show resolved Hide resolved
6-package-preview/README.md Show resolved Hide resolved
6-package-preview/README.md Outdated Show resolved Hide resolved
6-package-preview/README.md Outdated Show resolved Hide resolved
Flags:
--set stringToString Specify package variables to set on the command line (KEY=value) (default [])
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
--confirm Confirm package preview without prompting
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see a reason to add confirmation for the preview, it doesn't provide any value.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right now, on zarf package create if a user has templates they haven't defined with --set then they get an interactive prompt to define them. Confirm would skip that prompt. I can see the argument for getting rid of confirm and forcing users to use the --set flag when they don't have templates

6-package-preview/README.md Outdated Show resolved Hide resolved
6-package-preview/README.md Outdated Show resolved Hide resolved
AustinAbro321 and others added 6 commits December 10, 2024 09:54
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
Signed-off-by: Austin Abro <[email protected]>
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.

4 participants