diff --git a/cmd/flux/build_artifact.go b/cmd/flux/build_artifact.go index 957aec99..9da0ca0e 100644 --- a/cmd/flux/build_artifact.go +++ b/cmd/flux/build_artifact.go @@ -33,8 +33,8 @@ import ( var buildArtifactCmd = &cobra.Command{ Use: "artifact", Short: "Build artifact", - Long: withPreviewNote(`The build artifact command creates a tgz file with the manifests -from the given directory or a single manifest file.`), + Long: `The build artifact command creates a tgz file with the manifests +from the given directory or a single manifest file.`, Example: ` # Build the given manifests directory into an artifact flux build artifact --path ./path/to/local/manifests --output ./path/to/artifact.tgz diff --git a/cmd/flux/diff_artifact.go b/cmd/flux/diff_artifact.go index 33178b09..836a3074 100644 --- a/cmd/flux/diff_artifact.go +++ b/cmd/flux/diff_artifact.go @@ -32,7 +32,7 @@ import ( var diffArtifactCmd = &cobra.Command{ Use: "artifact", Short: "Diff Artifact", - Long: withPreviewNote(`The diff artifact command computes the diff between the remote OCI artifact and a local directory or file`), + Long: `The diff artifact command computes the diff between the remote OCI artifact and a local directory or file`, Example: `# Check if local files differ from remote flux diff artifact oci://ghcr.io/stefanprodan/manifests:podinfo:6.2.0 --path=./kustomize`, RunE: diffArtifactCmdRun, diff --git a/cmd/flux/list_artifact.go b/cmd/flux/list_artifact.go index f686b8ae..82f9e686 100644 --- a/cmd/flux/list_artifact.go +++ b/cmd/flux/list_artifact.go @@ -49,8 +49,8 @@ func newListArtifactFlags() listArtifactFlags { var listArtifactsCmd = &cobra.Command{ Use: "artifacts", Short: "list artifacts", - Long: withPreviewNote(`The list command fetches the tags and their metadata from a remote OCI repository. -The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`), + Long: `The list command fetches the tags and their metadata from a remote OCI repository. +The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`, Example: ` # List the artifacts stored in an OCI repository flux list artifact oci://ghcr.io/org/config/app `, diff --git a/cmd/flux/pull_artifact.go b/cmd/flux/pull_artifact.go index 42763b66..4f60adae 100644 --- a/cmd/flux/pull_artifact.go +++ b/cmd/flux/pull_artifact.go @@ -33,8 +33,8 @@ import ( var pullArtifactCmd = &cobra.Command{ Use: "artifact", Short: "Pull artifact", - Long: withPreviewNote(`The pull artifact command downloads and extracts the OCI artifact content to the given path. -The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`), + Long: `The pull artifact command downloads and extracts the OCI artifact content to the given path. +The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`, Example: ` # Pull an OCI artifact created by flux from GHCR flux pull artifact oci://ghcr.io/org/manifests/app:v0.0.1 --output ./path/to/local/manifests `, diff --git a/cmd/flux/push_artifact.go b/cmd/flux/push_artifact.go index 03eb45b9..7a0ddd3f 100644 --- a/cmd/flux/push_artifact.go +++ b/cmd/flux/push_artifact.go @@ -44,8 +44,8 @@ import ( var pushArtifactCmd = &cobra.Command{ Use: "artifact", Short: "Push artifact", - Long: withPreviewNote(`The push artifact command creates a tarball from the given directory or the single file and uploads the artifact to an OCI repository. -The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`), + Long: `The push artifact command creates a tarball from the given directory or the single file and uploads the artifact to an OCI repository. +The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`, Example: ` # Push manifests to GHCR using the short Git SHA as the OCI artifact tag echo $GITHUB_PAT | docker login ghcr.io --username flux --password-stdin flux push artifact oci://ghcr.io/org/config/app:$(git rev-parse --short HEAD) \ diff --git a/cmd/flux/tag_artifact.go b/cmd/flux/tag_artifact.go index 97b2be15..aa65d85b 100644 --- a/cmd/flux/tag_artifact.go +++ b/cmd/flux/tag_artifact.go @@ -31,8 +31,8 @@ import ( var tagArtifactCmd = &cobra.Command{ Use: "artifact", Short: "Tag artifact", - Long: withPreviewNote(`The tag artifact command creates tags for the given OCI artifact. -The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`), + Long: `The tag artifact command creates tags for the given OCI artifact. +The command can read the credentials from '~/.docker/config.json' but they can also be passed with --creds. It can also login to a supported provider with the --provider flag.`, Example: ` # Tag an artifact version as latest flux tag artifact oci://ghcr.io/org/manifests/app:v0.0.1 --tag latest `,