CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [6.0.0] - 2024-10-30
+
+### Changed
+
+- Added a new `development` stage to `./auto-devops-stages.yml`. Renamed the `review` stage to
+  align with Google Cloud workspace naming conventions.
+
 ## [5.2.1] - 2024-10-25
 
 ### Changed

auto-devops-stages.yml

-# A copy of the Auto DevOps stages. Useful for standalone templates which need to import Auto DevOps-like templates.
+# auto-devops-stages.yml is a copy of the Auto DevOps stages. Useful for standalone templates which
+# need to import Auto DevOps-like templates.
 stages:
   - build
   - test
   - deploy  # dummy stage to follow the template guidelines
   - review
   - dast
+  - development
   - staging
   - canary
   - production

auto-devops/artifact-registry.yml

-# This template pushes images built via Auto-DevOps to Google Artifact Registry in the meta project for the specific
-# product. This can only be used for products which have been provisioned using the gcp-product-factory, and which have
-# a product-specific GKE-based GitLab runner deployed.
+# artifact-registry.yml pushes images built via Auto-DevOps to Google Artifact Registry in the meta
+# project for the specific product. This can only be used for products which have been provisioned
+# using the gcp-product-factory, and which have a product-specific GKE-based GitLab runner deployed.
 #
 # This template is intended to be "include"-d in addition to the standard Auto-DevOps template, for example:
 #
 # include:
-#   - template: Auto-DevOps.gitlab-ci.yml
+#   - project: uis/devops/continuous-delivery/ci-templates
+#     file: /auto-devops.gitlab-ci.yml
 #
 #   - project: 'uis/devops/continuous-delivery/ci-templates'
 #     file: '/auto-devops/artifact-registry.yml'
@@ -94,7 +95,7 @@ artifact-registry-push:
 
 artifact-registry-push-dev:
   extends: .artifact-registry-base
-  stage: review
+  stage: development
   rules:
     - if: $DISABLE_ARTIFACT_REGISTRY_PUSH
       when: never

auto-devops/auto-devops.gitlab-ci.yml

+# auto-devops.gitlab-ci.yml is a customised version of the Auto-DevOps.gitlab-ci.yml template.
+# Templates using auto-devops should include: this template rather than Auto-DevOps.gitlab-ci.yml
+include:
+  - template: Auto-DevOps.gitlab-ci.yml
+  - local: /auto-devops-stages.yml
+

auto-devops/common-pipeline.yml

@@ -7,9 +7,7 @@
 # We add a "default" workflow rule but downstream users of this template can easily override these with their own.
 
 include:
-  # Bring in the AutoDevOps template from GitLab. It can be viewed at:
-  # https://gitlab.com/gitlab-org/gitlab-ee/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml
-  - template: Auto-DevOps.gitlab-ci.yml
+  - local: /auto-devops.gitlab-ci.yml
 
   # Utilities
   - local: "/python-common.yml"

auto-devops/extra-tags.yml

@@ -6,7 +6,8 @@
 # template first and *then* pull in this set of overrides.
 #
 # include:
-#   - template: Auto-DevOps.gitlab-ci.yml
+#   - project: uis/devops/continuous-delivery/ci-templates
+#     file: /auto-devops.gitlab-ci.yml
 #   - project: 'uis/devops/continuous-delivery/ci-templates'
 #     file: '/auto-devops/extra-tags.yml'
 #

auto-devops/release-it.yml

-# This template enables automated release management using the release-it tool.
+# release-it.yml enables automated release management using the release-it tool.
 
 include:
   - local: /fragments/get-gcp-secrets.yml
@@ -42,7 +42,7 @@ include:
 
 update-release-merge-request:
   extends: .release-base
-  stage: review
+  stage: development
   script: /opt/devops/update-merge-request.sh
   needs: []
   rules:
@@ -67,7 +67,7 @@ release:
     # branches starting "release/fix-" and only if the automated release bot commit was merged as the most recent commit.
     - if: ($CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH || $CI_COMMIT_BRANCH =~ /^release\/fix-.*$/i) && $USE_MERGE_REQUEST_RELEASE_FLOW && $CI_COMMIT_MESSAGE =~ /chore\(release\)/
     # If we're using the merge request workflow but all previous rules have not matched then we do not run the
-    # release job. 
+    # release job.
     - if: $USE_MERGE_REQUEST_RELEASE_FLOW
       when: never
     # Finally, we can assume we're running in the default mode and we simply run this release job if we are on the

auto-devops/terraform-pipeline.yml

-# Implements the UIS DevOps workflow for deploying product Terraform configurations.
+# terraform-pipeline.yml defines the UIS DevOps workflow for deploying product Terraform configurations.
 #
 # This template is intended to be "include"-d in .gitlab-ci.yml configurations. It uses the base jobs defined in
 # terraform-pipeline-base.yml to build a drop in deployment pipeline for our standard GCP products.
@@ -60,7 +60,7 @@ include:
 # additional environments, these jobs can be copied as require in the product's infrastructure repository directly.
 terraform-plan-development:
   extends: .terraform-plan
-  stage: review
+  stage: development
   rules:
     - if: $TERRAFORM_PLAN_DEVELOPMENT_DISABLED
       when: never
@@ -70,7 +70,7 @@ terraform-plan-development:
 
 terraform-apply-development:
   extends: .terraform-apply
-  stage: review
+  stage: development
   rules:
     - if: $TERRAFORM_APPLY_DEVELOPMENT_DISABLED
       when: never

auto-devops/tox-tests.yml

@@ -6,7 +6,8 @@
 # template first and *then* pull in this set of overrides.
 #
 # include:
-#   - template: Auto-DevOps.gitlab-ci.yml
+#   - project: uis/devops/continuous-delivery/ci-templates
+#     file: /auto-devops.gitlab-ci.yml
 #   - project: 'uis/devops/continuous-delivery/ci-templates'
 #     file: '/auto-devops/tox-tests.yml'
 #