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

Improve package publish UX for skeleton and create+publish flows #3317

Open
AustinAbro321 opened this issue Dec 11, 2024 · 0 comments
Open
Labels
enhancement ✨ New feature or request

Comments

@AustinAbro321
Copy link
Contributor

AustinAbro321 commented Dec 11, 2024

Is your feature request related to a problem? Please describe.

There are currently a few UX problems with publishing normal (non-skeleton) Zarf packages.

  • A user running zarf package publish path/to/package may expect their package to be built and published. Instead a skeleton package will be published. We have seen multiple community members post that this behavior is confusing
  • Users may want to publish and create a package in one step. This may be important if they have an extremely large package that is expensive to compress and decompress. It is possible to do this with zarf package create path/to/package --output=oci://registry, however this is not easy to discover. The typical user would expect this functionality in zarf package publish path/to/package

The solution should be done as follows

  1. Deprecate zarf package publish path/to/dir by replacing it with a new command zarf package publish skeleton path/to/dir. After a year has passed zarf package publish path/to/dir should create and publish a normal package.
  2. Once the above has been fully implemented, deprecate the --output=oci://registry functionality from create and warn users to switch to zarf package publish. After a year remove the --output functionality.
@AustinAbro321 AustinAbro321 added the enhancement ✨ New feature or request label Dec 11, 2024
@AustinAbro321 AustinAbro321 changed the title Improve command UX of publishing packages Improve package publish UX for skeleton and create+publish flows Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ✨ New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant