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

add a preview note for all non-bootstrap commands #3754

Merged
merged 1 commit into from
Apr 5, 2023

Conversation

aryan9600
Copy link
Member

@aryan9600 aryan9600 commented Apr 4, 2023

add the following note to all non-GA commands as described in #3274:

⚠️ Please note that this command (group) is in preview and under development.
While we try our best to not introduce breaking changes, they may occur when
we adapt to new features and/or find better ways to facilitate what it does.

fixes #3739

@aryan9600 aryan9600 changed the title add a preview note for all non-bootstrp commands add a preview note for all non-bootstrap commands Apr 4, 2023
@stefanprodan stefanprodan changed the base branch from main to release-v2.0.0-rc.1 April 4, 2023 10:08
@stefanprodan
Copy link
Member

@aryan9600 please rebase with the release-v2.0.0-rc.1

@stefanprodan
Copy link
Member

@aryan9600 the warning must be displayed only on commands that don't deal with v1 APIs. As listed here: #3274

cmd/flux/build.go Outdated Show resolved Hide resolved
cmd/flux/main.go Outdated Show resolved Hide resolved
@aryan9600 aryan9600 force-pushed the preview-warning branch 2 times, most recently from 381b1c7 to c8db969 Compare April 4, 2023 17:24
@@ -42,7 +42,7 @@ var createKsCmd = &cobra.Command{
Use: "kustomization [name]",
Aliases: []string{"ks"},
Short: "Create or update a Kustomization resource",
Long: "The create command generates a Kustomization resource for a given source.",
Long: `The create command generates a Kustomization resource for a given source.`,
Copy link
Contributor

@darkowlzz darkowlzz Apr 4, 2023

Choose a reason for hiding this comment

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

Maybe undo such changes to keep the diff focused on non-GA commands only?
Or convert all the long message of every command to use the same syntax.

@darkowlzz
Copy link
Contributor

Just wanted to see how others feel about the idea I've been thinking about while going though the changes.
For commands that have some subcommands that are GA, how about not marking the parent command as preview?
For example, flux create and flux create source need not be marked as preview, but only the specific subcommands, like flux create source bucket can be marked as preview, wherever relevant. That way, it doesn't give the impression that the whole create or create source command group is in preview.
I think this would make the preview marker more granular instead of a catch-all like implementation. In relation to a previous discussion about marking only git secret creation GA, I think this would make it more apt to selectively mark other secret types as preview. Removing the oddness of overall command group being in preview but only one small part of it being GA.

@makkes
Copy link
Member

makkes commented Apr 5, 2023

Just wanted to see how others feel about the idea I've been thinking about while going though the changes. For commands that have some subcommands that are GA, how about not marking the parent command as preview? For example, flux create and flux create source need not be marked as preview, but only the specific subcommands, like flux create source bucket can be marked as preview, wherever relevant. That way, it doesn't give the impression that the whole create or create source command group is in preview. I think this would make the preview marker more granular instead of a catch-all like implementation. In relation to a previous discussion about marking only git secret creation GA, I think this would make it more apt to selectively mark other secret types as preview. Removing the oddness of overall command group being in preview but only one small part of it being GA.

Yes, I agree. Seeing the warning on flux create is strange, given that flux create source git doesn't show it. Same is true for other groups. And then we can remove the (group) from the message as well and make the warning more specific.

@stefanprodan
Copy link
Member

For commands that have some subcommands that are GA, how about not marking the parent command as preview?

Yes +1

Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@darkowlzz darkowlzz left a comment

Choose a reason for hiding this comment

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

LGTM!

@stefanprodan stefanprodan merged commit 768ed29 into fluxcd:release-v2.0.0-rc.1 Apr 5, 2023
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.

Mark non-bootstrap commands as "in preview and under development"
5 participants