docs: update tag flag description (#5004)

Resolves #4973


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the Apache 2.0 License.

internal/pkg/cli/flag.go

@@ -304,7 +304,7 @@ output the manifest file used for that deployment.`
 	containerFlagDescription   = "Optional. The specific container you want to exec in. By default the first essential container will be used."
 
 	// Build.
-	imageTagFlagDescription     = `Optional. The container image tag.`
+	imageTagFlagDescription     = `Optional. The tag for the container images Copilot builds from Dockerfiles.`
 	uploadAssetsFlagDescription = `Optional. Whether to upload assets (container images, Lambda functions, etc.).
 Uploaded asset locations are filled in the template configuration.`
 	stackOutputDirFlagDescription = "Optional. Writes the stack template and template configuration to a directory."

mkdocs.yml

@@ -128,6 +128,7 @@ nav:
         - app show: docs/commands/app-show.en.md
         - app upgrade: docs/commands/app-upgrade.en.md
         - completion: docs/commands/completion.en.md
+        - deploy: docs/commands/deploy.en.md
         - docs: docs/commands/docs.en.md
         - env delete: docs/commands/env-delete.en.md
         - env deploy: docs/commands/env-deploy.en.md

site/content/docs/commands/deploy.en.md

@@ -7,11 +7,12 @@ $ copilot deploy
 
 This command is used to run either [`copilot svc deploy`](../commands/svc-deploy.en.md) or [`copilot job deploy`](../commands/job-deploy.en.md) under the hood. The steps involved in `copilot deploy` are the same as those involved in `copilot svc deploy` and `copilot job deploy`:
 
-1. Build your local Dockerfile into an image
-2. Tag it with the value from `--tag` or the latest git sha (if you're in a git directory)
-3. Push the image to ECR
-4. Package your manifest file and addons into CloudFormation
-5. Create / update your ECS task definition and job or service.
+1. When `image.build` exists in the manifest:
+    1. Build your local Dockerfile into an image
+    2. Tag it with the value from `--tag` or the latest git sha (if you're in a git directory)
+    3. Push the image to ECR
+2. Package your manifest file and addons into CloudFormation
+3. Create / update your ECS task definition and job or service.
 
 ## What are the flags?
 
@@ -27,7 +28,7 @@ This command is used to run either [`copilot svc deploy`](../commands/svc-deploy
                                        production environment.
       --resource-tags stringToString   Optional. Labels with a key and value separated by commas.
                                        Allows you to categorize resources. (default [])
-      --tag string                     Optional. The container image tag.
+      --tag string                     Optional. The tag for the container images Copilot builds from Dockerfiles.
 ```
 
 !!!info

site/content/docs/commands/deploy.ja.md

@@ -28,7 +28,7 @@ $ copilot deploy
                                        production environment.
       --resource-tags stringToString   Optional. Labels with a key and value separated by commas.
                                        Allows you to categorize resources. (default [])
-      --tag string                     Optional. The container image tag.
+      --tag string                     Optional. The tag for the container images Copilot builds from Dockerfiles.
 ```
 
 !!!info

site/content/docs/commands/init.en.md

@@ -30,7 +30,7 @@ Like all commands in the Copilot CLI, if you don't provide required flags, we'll
                             For example: "0 * * * *", "@daily", "@weekly", "@every 1h30m".
                             AWS Schedule Expressions of the form "rate(10 minutes)" or "cron(0 12 L * ? 2021)"
                             are also accepted.
-      --tag string          Optional. The container image tag.
+      --tag string          Optional. The tag for the container images Copilot builds from Dockerfiles.
       --timeout string      Optional. The total execution time for the task, including retries.
                             Accepts valid Go duration strings. For example: "2h", "1h30m", "900s".
   -t, --type string         Type of service to create. Must be one of:

site/content/docs/commands/init.ja.md

@@ -30,7 +30,7 @@ Copilot CLI の全てのコマンドと同様に、必要なフラグを指定
                             For example: "0 * * * *", "@daily", "@weekly", "@every 1h30m".
                             AWS Schedule Expressions of the form "rate(10 minutes)" or "cron(0 12 L * ? 2021)"
                             are also accepted.
-      --tag string          Optional. The container image tag.
+      --tag string          Optional. The tag for the container images Copilot builds from Dockerfiles.
       --timeout string      Optional. The total execution time for the task, including retries.
                             Accepts valid Go duration strings. For example: "2h", "1h30m", "900s".
   -t, --type string         Type of service to create. Must be one of:

site/content/docs/commands/job-deploy.en.md

@@ -9,11 +9,12 @@ $ copilot job deploy
 
 The steps involved in `job deploy` are:
 
-1. Build your local Dockerfile into an image
-2. Tag it with the value from `--tag` or the latest git sha (if you're in a git directory)
-3. Push the image to ECR
-4. Package your manifest file and addons into CloudFormation
-4. Create / update your ECS task definition and job
+1. When `image.build` exists in the manifest:
+    1. Build your local Dockerfile into an image
+    2. Tag it with the value from `--tag` or the latest git sha (if you're in a git directory)
+    3. Push the image to ECR
+2. Package your manifest file and addons into CloudFormation
+3. Create / update your ECS task definition and job
 
 ## What are the flags?
 
@@ -29,7 +30,7 @@ The steps involved in `job deploy` are:
                                        production environment.
       --resource-tags stringToString   Optional. Labels with a key and value separated by commas.
                                        Allows you to categorize resources. (default [])
-      --tag string                     Optional. The container image tag.
+      --tag string                     Optional. The tag for the container images Copilot builds from Dockerfiles.
 ```
 
 !!!info

site/content/docs/commands/job-deploy.ja.md

@@ -29,7 +29,7 @@ $ copilot job deploy
                                        production environment.
       --resource-tags stringToString   Optional. Labels with a key and value separated by commas.
                                        Allows you to categorize resources. (default [])
-      --tag string                     Optional. The container image tag.
+      --tag string                     Optional. The tag for the container images Copilot builds from Dockerfiles.
 ```
 
 !!!info

site/content/docs/commands/job-package.en.md

@@ -16,7 +16,7 @@ $ copilot job package
   -h, --help                help for package
   -n, --name string         Name of the job.
       --output-dir string   Optional. Writes the stack template and template configuration to a directory.
-      --tag string          Optional. The container image tag.
+      --tag string          Optional. The tag for the container images Copilot builds from Dockerfiles.
       --upload-assets       Optional. Whether to upload assets (container images, Lambda functions, etc.).
                             Uploaded asset locations are filled in the template configuration.
 ```

site/content/docs/commands/job-package.ja.md

@@ -16,7 +16,7 @@ $ copilot job package
   -h, --help                help for package
   -n, --name string         Name of the job.
       --output-dir string   Optional. Writes the stack template and template configuration to a directory.
-      --tag string          Optional. The container image tag.
+      --tag string          Optional. The tag for the container images Copilot builds from Dockerfiles.
       --upload-assets       Optional. Whether to upload assets (container images, Lambda functions, etc.).
                             Uploaded asset locations are filled in the template configuration.
 ```

site/content/docs/commands/svc-deploy.en.md

@@ -9,11 +9,12 @@ $ copilot svc deploy
 
 The steps involved in service deploy are:
 
-1. Build your local Dockerfile into an image
-2. Tag it with the value from `--tag` or the latest git sha (if you're in a git directory)
-3. Push the image to ECR
-4. Package your manifest file and addons into CloudFormation
-4. Create / update your ECS task definition and service
+1. When `image.build` exists in the manifest:
+    1. Build your local Dockerfile into an image
+    2. Tag it with the value from `--tag` or the latest git sha (if you're in a git directory)
+    3. Push the image to ECR
+2. Package your manifest file and addons into CloudFormation
+3. Create / update your ECS task definition and service
 
 ## What are the flags?
 
@@ -30,7 +31,7 @@ The steps involved in service deploy are:
                                        production environment.
       --resource-tags stringToString   Optional. Labels with a key and value separated by commas.
                                        Allows you to categorize resources. (default [])
-      --tag string                     Optional. The container image tag.
+      --tag string                     Optional. The tag for the container images Copilot builds from Dockerfiles.
 ```
 
 !!!info

site/content/docs/commands/svc-deploy.ja.md

@@ -30,7 +30,7 @@ Service デプロイの手順は以下の通りです。
                                        production environment.
       --resource-tags stringToString   Optional. Labels with a key and value separated by commas.
                                        Allows you to categorize resources. (default [])
-      --tag string                     Optional. The container image tag.
+      --tag string                     Optional. The tag for the container images Copilot builds from Dockerfiles.
 ```
 
 !!!info