From 614823ec9743cf751acf4eff20c8c9e6d2536915 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Etienne=20Baqu=C3=A9?= <ebaque@gitlab.com>
Date: Sat, 18 Jul 2020 05:28:33 +0000
Subject: [PATCH] Removed deprecated ECS template
---
.../220821-remove-deprecated-ecs-template.yml | 5 +++++
doc/ci/cloud_deployment/index.md | 13 +++++++------
lib/gitlab/ci/templates/Deploy-ECS.gitlab-ci.yml | 16 ++++++----------
3 files changed, 18 insertions(+), 16 deletions(-)
create mode 100644 changelogs/unreleased/220821-remove-deprecated-ecs-template.yml
diff --git a/changelogs/unreleased/220821-remove-deprecated-ecs-template.yml b/changelogs/unreleased/220821-remove-deprecated-ecs-template.yml
new file mode 100644
index 0000000000000..062514a1ca645
--- /dev/null
+++ b/changelogs/unreleased/220821-remove-deprecated-ecs-template.yml
@@ -0,0 +1,5 @@
+---
+title: Deprecation of ECS template
+merge_request: 36143
+author:
+type: deprecated
diff --git a/doc/ci/cloud_deployment/index.md b/doc/ci/cloud_deployment/index.md
index 29ce8bdf6250e..a2dea5006cac5 100644
--- a/doc/ci/cloud_deployment/index.md
+++ b/doc/ci/cloud_deployment/index.md
@@ -81,11 +81,12 @@ path to point to your ECR image.
### Deploy your application to the AWS Elastic Container Service (ECS)
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207962) in GitLab 12.9.
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207962) in GitLab 12.9.
+> - The `Deploy-ECS.gitlab-ci.yml` template was deprecated in favor of `AWS/Deploy-ECS.gitlab-ci.yml` template in GitLab 13.2.
GitLab provides a series of [CI templates that you can include in your project](../yaml/README.md#include).
To automate deployments of your application to your [Amazon Elastic Container Service](https://aws.amazon.com/ecs/) (AWS ECS)
-cluster, you can `include` the `Deploy-ECS.gitlab-ci.yml` template in your `.gitlab-ci.yml` file.
+cluster, you can `include` the `AWS/Deploy-ECS.gitlab-ci.yml` template in your `.gitlab-ci.yml` file.
GitLab also provides [Docker images](https://gitlab.com/gitlab-org/cloud-deploy/-/tree/master/aws) that can be used in your `gitlab-ci.yml` file to simplify working with AWS:
@@ -129,7 +130,7 @@ After you're all set up on AWS ECS, follow these steps:
- template: AWS/Deploy-ECS.gitlab-ci.yml
```
- The `Deploy-ECS` template ships with GitLab and is available [on
+ The `AWS/Deploy-ECS` template ships with GitLab and is available [on
GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/AWS/Deploy-ECS.gitlab-ci.yml).
1. Commit and push your updated `.gitlab-ci.yml` to your project's repository, and you're done!
@@ -143,17 +144,17 @@ After you're all set up on AWS ECS, follow these steps:
application.
CAUTION: **Warning:**
-The [`Deploy-ECS.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/AWS/Deploy-ECS.gitlab-ci.yml)
+The [`AWS/Deploy-ECS.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/AWS/Deploy-ECS.gitlab-ci.yml)
template includes both the [`Jobs/Build.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Jobs/Build.gitlab-ci.yml)
and [`Jobs/Deploy/ECS.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Jobs/Deploy/ECS.gitlab-ci.yml)
"sub-templates". Do not include these "sub-templates" on their own, and only include the main
-`Deploy-ECS.gitlab-ci.yml` template. The "sub-templates" are designed to only be
+`AWS/Deploy-ECS.gitlab-ci.yml` template. The "sub-templates" are designed to only be
used along with the main template. They may move or change unexpectedly causing your
pipeline to fail if you didn't include the main template. Also, the job names within
these templates may change. Do not override these jobs names in your own pipeline,
as the override will stop working when the name changes.
-Alternatively, if you don't wish to use the `Deploy-ECS.gitlab-ci.yml` template
+Alternatively, if you don't wish to use the `AWS/Deploy-ECS.gitlab-ci.yml` template
to deploy to AWS ECS, you can always use our
`aws-base` Docker image to run your own [AWS CLI commands for ECS](https://docs.aws.amazon.com/cli/latest/reference/ecs/index.html#cli-aws-ecs).
diff --git a/lib/gitlab/ci/templates/Deploy-ECS.gitlab-ci.yml b/lib/gitlab/ci/templates/Deploy-ECS.gitlab-ci.yml
index 5f4bd631db6bd..c1815baf7e660 100644
--- a/lib/gitlab/ci/templates/Deploy-ECS.gitlab-ci.yml
+++ b/lib/gitlab/ci/templates/Deploy-ECS.gitlab-ci.yml
@@ -1,4 +1,4 @@
-# This template is deprecated and will be removed as part of GitLab 13.2!
+# This template is deprecated.
#
# If you have referenced this template in your CI pipeline, please
# update your CI configuration by replacing the following occurrence(s):
@@ -20,12 +20,8 @@ stages:
- deploy
- production
-before_script:
- - printf '\nWARNING!\nThis job includes "Deploy-ECS.gitlab-ci.yml". Please rename this to "AWS/Deploy-ECS.gitlab-ci.yml".\n'
-
-variables:
- AUTO_DEVOPS_PLATFORM_TARGET: ECS
-
-include:
- - template: Jobs/Build.gitlab-ci.yml
- - template: Jobs/Deploy/ECS.gitlab-ci.yml
+"error: Template has moved":
+ stage: deploy
+ script:
+ - echo "Deploy-ECS.gitlab-ci.yml has been moved to AWS/Deploy-ECS.gitlab-ci.yml, see https://docs.gitlab.com/ee/ci/cloud_deployment/#deploy-your-application-to-the-aws-elastic-container-service-ecs for more details."
+ - exit 1
--
GitLab