Add destroy pipeline

templates/destroy-pipeline.yml

+spec:
+  inputs:
+    # Stages
+    stage_plan:
+      default: 'plan'
+      description: 'Defines the plan stage. This stage includes the `plan` job.'
+    stage_destroy:
+      default: 'destroy'
+      description: 'Defines the destroy stage. This stage includes the `destroy` and `delete-state` jobs.'
+
+    # Jobs
+    plan_job_name:
+      default: 'plan'
+      description: 'Name of the plan job.'
+
+    # Versions
+    # This version is only required, because we cannot access the context of the component,
+    # see https://gitlab.com/gitlab-org/gitlab/-/issues/438275
+    version:
+      default: 'latest'
+      description: 'Version of this component. Has to be the same as the one in the component include entry.'
+      
+    opentofu_version:
+      default: '1.6.1'
+      options:
+        - '$OPENTOFU_VERSION'
+        - '1.6.1'
+        - '1.6.0'
+        - '1.6.0-rc1'
+      description: 'OpenTofu version that should be used.'
+
+    # Images
+    image_registry_base:
+      default: '$CI_REGISTRY/components/opentofu'
+    # FIXME: not yet possible because of https://gitlab.com/gitlab-org/gitlab/-/issues/438722
+    # gitlab_opentofu_image:
+    #   # FIXME: This should reference the component tag that is used.
+    #   #        Currently, blocked by https://gitlab.com/gitlab-org/gitlab/-/issues/438275
+    #   # default: '$CI_REGISTRY/components/opentofu/gitlab-opentofu:$[[ inputs.opentofu_version ]]'
+    #   default: '$CI_REGISTRY/components/opentofu/gitlab-opentofu:$[[ inputs.version ]]-opentofu$[[ inputs.opentofu_version ]]'
+    #   description: 'Tag of the gitlab-opentofu image.'
+    
+    # Configuration
+    root_dir: 
+      default: ${CI_PROJECT_DIR}
+      description: 'Root directory for the OpenTofu project.'
+    state_name:
+      default: default
+      description: 'Remote OpenTofu state name.'
+    auto_destroy:
+      default: 'false'
+      description: 'Whether the destroy job is manual or automatically run.'
+
+---
+
+include:
+  - local: '/templates/plan.yml'
+    inputs:
+      as: $[[ inputs.plan_job_name ]]
+      stage: $[[ inputs.stage_build ]]
+      version: $[[ inputs.version ]]
+      opentofu_version: $[[ inputs.opentofu_version ]]
+      image_registry_base: $[[ inputs.image_registry_base ]]
+      root_dir: $[[ inputs.root_dir ]]
+      state_name: $[[ inputs.state_name ]]
+      plan: destroy-plan.cache
+      destroy_plan: true
+  - local: '/templates/destroy.yml'
+    inputs:
+      as: 'destroy'
+      stage: $[[ inputs.stage_cleanup ]]
+      version: $[[ inputs.version ]]
+      opentofu_version: $[[ inputs.opentofu_version ]]
+      image_registry_base: $[[ inputs.image_registry_base ]]
+      root_dir: $[[ inputs.root_dir ]]
+      state_name: $[[ inputs.state_name ]]
+      auto_destroy: $[[ inputs.auto_apply ]]
+      plan: $[[ inputs.root_dir ]]/destroy-plan.cache
+  - local: '/templates/delete-state.yml'
+    inputs:
+      as: 'delete-state'
+      stage: $[[ inputs.stage_cleanup ]]
+      state_name: $[[ inputs.state_name ]]
+
+# NOTE: we have to define this `needs` here, because inputs don't support arrays, yet.
+destroy:
+  needs: 
+    - '$[[ inputs.plan_job_name ]]'
+
+delete-state:
+  needs: [destroy]

templates/full-pipeline.yml

@@ -94,22 +94,18 @@ include:
       root_dir: $[[ inputs.root_dir ]]
       state_name: $[[ inputs.state_name ]]
       auto_apply: $[[ inputs.auto_apply ]]
-  - local: '/templates/destroy.yml'
+
+destroy:
+  stage: cleanup
+  trigger:
+    include: /templates/destroy-pipeline.yml
+    strategy: depend
     inputs:
-      as: 'destroy'
-      stage: $[[ inputs.stage_cleanup ]]
       version: $[[ inputs.version ]]
       opentofu_version: $[[ inputs.opentofu_version ]]
       image_registry_base: $[[ inputs.image_registry_base ]]
       root_dir: $[[ inputs.root_dir ]]
       state_name: $[[ inputs.state_name ]]
-      auto_destroy: $[[ inputs.auto_apply ]]
-  - local: '/templates/delete-state.yml'
-    inputs:
-      as: 'delete-state'
-      stage: $[[ inputs.stage_cleanup ]]
-      state_name: $[[ inputs.state_name ]]
-
-# NOTE: we have to define this `needs` here, because inputs don't support arrays, yet.
-delete-state:
-  needs: [destroy]
+      auto_destroy: $[[ inputs.auto_destroy ]]
+  rules:
+    - when: manual

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

@@ -25,7 +25,3 @@ apply:
 
 destroy:
   rules: [{when: always}]
-
-delete-state:
-  rules: [{when: always}]
-