Add suggestion job

backports/.Base.gitlab-ci.yml

@@ -23,3 +23,30 @@ variables:
   TF_ROOT: ${CI_PROJECT_DIR}
   # The name of the state file used by the GitLab Managed Terraform state backend
   TF_STATE_NAME: default
+
+.opentofu:suggest-component:
+  stage: validate
+  needs: []
+  allow_failure: true
+  rules:
+    if: '"$CI_SERVER_HOST" == "gitlab.com"'
+  image: alpine:3.19
+  script:
+    - |
+      echo "You are using the OpenTofu CI/CD template on GitLab.com which is not recommended."
+      echo "This template is available for self-managed customers until CI/CD components are available to them and it will be removed asap."
+      echo
+      echo "We recommed that you migrate to the OpenTofu CI/CD component instead."
+      echo "The OpenTofu CI/CD component with a default configuration can be included as follows:"
+      echo
+      echo "include:"
+      echo "  - component: gitlab.com/components/opentofu/full-pipeline@0.1.0"
+      echo "    inputs:"
+      echo "      version: latest"
+      echo "      opentofu_version: 1.6.0"
+      echo
+      echo "stages: [validate, test, build, deploy]"
+      echo
+      echo "You can read about more about the OpenTofu CI/CD component here:"
+      echo "https://gitlab.com/components/opentofu"
+    - false

backports/OpenTofu.gitlab-ci.yml

@@ -17,6 +17,9 @@ include:
 
 stages: [validate, build, deploy]
 
+suggest-component:
+  extends: .opentofu:suggest-component
+
 fmt:
   extends: .opentofu:fmt
 

backports/OpenTofu/Base.gitlab-ci.yml

@@ -24,6 +24,33 @@ variables:
   # The name of the state file used by the GitLab Managed Terraform state backend
   TF_STATE_NAME: default
 
+.opentofu:suggest-component:
+  stage: validate
+  needs: []
+  allow_failure: true
+  rules:
+    if: '"$CI_SERVER_HOST" == "gitlab.com"'
+  image: alpine:3.19
+  script:
+    - |
+      echo "You are using the OpenTofu CI/CD template on GitLab.com which is not recommended."
+      echo "This template is available for self-managed customers until CI/CD components are available to them and it will be removed asap."
+      echo
+      echo "We recommed that you migrate to the OpenTofu CI/CD component instead."
+      echo "The OpenTofu CI/CD component with a default configuration can be included as follows:"
+      echo
+      echo "include:"
+      echo "  - component: gitlab.com/components/opentofu/full-pipeline@0.1.0"
+      echo "    inputs:"
+      echo "      version: latest"
+      echo "      opentofu_version: 1.6.0"
+      echo
+      echo "stages: [validate, test, build, deploy]"
+      echo
+      echo "You can read about more about the OpenTofu CI/CD component here:"
+      echo "https://gitlab.com/components/opentofu"
+    - false
+
 .opentofu:default:
   image:
     name: '$GITLAB_OPENTOFU_IMAGE_REGISTRY_BASE/gitlab-opentofu:$GITLAB_OPENTOFU_VERSION-opentofu$OPENTOFU_VERSION'

tests/integration-tests/BackportTemplates.gitlab-ci.yml

@@ -5,6 +5,9 @@ stages: [validate, test, build, deploy, cleanup]
 
 # Required to run everything immediately, instead of manually.
 
+suggest-component:
+  extends: .opentofu:suggest-component
+
 fmt:
   extends: .opentofu:fmt
   rules: [{when: always}]