Clarify the directory requirement in docs and help menu

Signed-off-by: Vu Dinh <[email protected]>

Author: dinhxuanvu

cmd/opm/alpha/bundle/build.go

@@ -23,7 +23,7 @@ func newBundleBuildCmd() *cobra.Command {
 		Short: "Build operator bundle image",
 		Long: `The "opm alpha bundle build" command will generate operator
         bundle metadata if needed and build bundle image with operator manifest
-        and metadata.
+        and metadata for a specific version.
 
         For example: The command will generate annotations.yaml metadata plus
         Dockerfile for bundle image and then build a container image from
@@ -33,15 +33,17 @@ func newBundleBuildCmd() *cobra.Command {
         After the build process is completed, a container image would be built
         locally in docker and available to push to a container registry.
 
-        $ opm alpha bundle build --directory /test/ --tag quay.io/example/operator:v0.1.0 \
+        $ opm alpha bundle build --directory /test/0.1.0/ --tag quay.io/example/operator:v0.1.0 \
 		--package test-operator --channels stable,beta --default stable --overwrite
 
-        Note: Bundle image is not runnable.
+		Note:
+		* Bundle image is not runnable.
+		* All manifests yaml must be in the same directory. 
         `,
 		RunE: buildFunc,
 	}
 
-	bundleBuildCmd.Flags().StringVarP(&dirBuildArgs, "directory", "d", "", "The directory where bundle manifests and metadata are located")
+	bundleBuildCmd.Flags().StringVarP(&dirBuildArgs, "directory", "d", "", "The directory where bundle manifests and metadata for a specific version are located")
 	if err := bundleBuildCmd.MarkFlagRequired("directory"); err != nil {
 		log.Fatalf("Failed to mark `directory` flag for `build` subcommand as required")
 	}

cmd/opm/alpha/bundle/generate.go

@@ -15,13 +15,16 @@ func newBundleGenerateCmd() *cobra.Command {
 		Long: `The "opm alpha bundle generate" command will generate operator
         bundle metadata if needed and a Dockerfile to build Operator bundle image.
 
-        $ opm alpha bundle generate --directory /test/ --package test-operator \
+        $ opm alpha bundle generate --directory /test/0.1.0/ --package test-operator \
 		--channels stable,beta --default stable
+
+		Note:
+		* All manifests yaml must be in the same directory.
         `,
 		RunE: generateFunc,
 	}
 
-	bundleGenerateCmd.Flags().StringVarP(&dirBuildArgs, "directory", "d", "", "The directory where bundle manifests are located.")
+	bundleGenerateCmd.Flags().StringVarP(&dirBuildArgs, "directory", "d", "", "The directory where bundle manifests for a specific version are located.")
 	if err := bundleGenerateCmd.MarkFlagRequired("directory"); err != nil {
 		log.Fatalf("Failed to mark `directory` flag for `generate` subcommand as required")
 	}

docs/design/operator-bundle.md

@@ -129,9 +129,12 @@ Usage:
 Flags:
   -c, --channels string    The list of channels that bundle image belongs to
   -e, --default string     The default channel for the bundle image
-  -d, --directory string   The directory where bundle manifests are located.
+  -d, --directory string   The directory where bundle manifests for a specific version are located.
   -h, --help               help for generate
   -p, --package string     The name of the package that bundle image belongs to
+
+  Note:
+  * All manifests yaml must be in the same directory.
 ```
 
 The `--directory/-d`, `--channels/-c`, `--package/-p` are required flags while `--default/-e` is optional.
@@ -175,12 +178,16 @@ Usage:
 Flags:
   -c, --channels string        The list of channels that bundle image belongs to
   -e, --default string         The default channel for the bundle image
-  -d, --directory string       The directory where bundle manifests are located
+  -d, --directory string       The directory where bundle manifests for a specific version are located
   -h, --help                   help for build
   -b, --image-builder string   Tool to build container images. One of: [docker, podman, buildah] (default "docker")
   -0, --overwrite               To overwrite annotations.yaml if existing
   -p, --package string         The name of the package that bundle image belongs to
   -t, --tag string             The name of the bundle image will be built
+
+  Note:
+  * Bundle image is not runnable.
+  * All manifests yaml must be in the same directory.
 ```
 
 The command for `build` task is:
@@ -189,7 +196,7 @@ $ ./operator-sdk bundle build --directory /test --tag quay.io/coreos/test-operat
 --package test-operator --channels stable,beta --default stable
 ```
 
-The `--directory` or `-d` specifies the directory where the operator manifests are located. The `--tag` or `-t` specifies the image tag that you want the operator bundle image to have. By using `build` command, the `annotations.yaml` and `Dockerfile` are automatically generated in the background.
+The `--directory` or `-d` specifies the directory where the operator manifests for a specific version are located. The `--tag` or `-t` specifies the image tag that you want the operator bundle image to have. By using `build` command, the `annotations.yaml` and `Dockerfile` are automatically generated in the background.
 
 The default image builder is `Docker`. However, ` Buildah` and `Podman` are also supported. An image builder can specified via `--image-builder` or `-b` optional tag in `build` command. For example:
 ```bash