docs-ci-cd: add ci cd doc and rename production release to manual rel…

…ease, adjust workflow names to have same syntax.
digitalfabrik · Nov 18, 2024 · 7c04fca · 7c04fca
1 parent 5275a30
commit 7c04fca
Show file tree

Hide file tree

Showing 8 changed files with 307 additions and 107 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1059,16 +1059,16 @@ parameters:
             - run
             - skip
         type: enum
-    run_deliver_beta_backend_administration:
+    run_delivery_beta_all:
         default: false
         type: boolean
-    run_deliver_production_backend_administration:
+    run_delivery_beta_backend_administration:
         default: false
         type: boolean
-    run_delivery_beta_all:
+    run_delivery_beta_native:
         default: false
         type: boolean
-    run_delivery_beta_native:
+    run_delivery_production_backend_administration:
         default: false
         type: boolean
     run_delivery_production_native:
@@ -1164,7 +1164,78 @@ workflows:
                     - equal:
                         - main
                         - << pipeline.git.branch >>
-    deliver_beta_all:
+    deliver_production_backend_administration:
+        jobs:
+            - bump_version:
+                context:
+                    - deliverino
+                platforms: web
+                prepare_delivery: true
+            - check_administration
+            - build_administration:
+                requires:
+                    - check_administration
+                    - bump_version
+            - pack_administration:
+                requires:
+                    - build_administration
+            - build_martin
+            - check_backend
+            - build_backend:
+                requires:
+                    - check_backend
+            - pack_backend:
+                requires:
+                    - build_backend
+                    - bump_version
+            - check_health_backend:
+                requires:
+                    - pack_backend
+            - pack_martin:
+                requires:
+                    - build_martin
+                    - bump_version
+            - pack_meta:
+                requires:
+                    - bump_version
+            - upload_packages_to_server:
+                bundle: administration
+                context:
+                    - credentials-ehrenamtskarte
+                name: upload_administration_packages_to_server_production
+                production: true
+                requires:
+                    - pack_administration
+                    - check_health_backend
+                    - pack_martin
+                    - pack_meta
+            - upload_packages_to_server:
+                bundle: backend
+                context:
+                    - credentials-ehrenamtskarte
+                name: upload_backend_packages_to_server_production
+                production: true
+                requires:
+                    - pack_administration
+                    - check_health_backend
+                    - pack_martin
+                    - pack_meta
+            - install_packages_to_server:
+                context:
+                    - credentials-ehrenamtskarte
+                name: install_packages_to_server_production
+                production: true
+                requires:
+                    - upload_administration_packages_to_server_production
+                    - upload_backend_packages_to_server_production
+            - notify_release:
+                context:
+                    - deliverino
+                production_delivery: true
+                requires:
+                    - install_packages_to_server_production
+        when: << pipeline.parameters.run_delivery_production_backend_administration >>
+    delivery_beta_all:
         jobs:
             - bump_version:
                 context:
@@ -1344,7 +1415,7 @@ workflows:
                     - upload_administration_packages_to_server_staging
                     - upload_backend_packages_to_server_staging
         when: << pipeline.parameters.run_delivery_beta_all >>
-    deliver_beta_backend_administration:
+    delivery_beta_backend_administration:
         jobs:
             - bump_version:
                 context:
@@ -1414,78 +1485,7 @@ workflows:
                 production_delivery: false
                 requires:
                     - install_packages_to_server_staging
-        when: << pipeline.parameters.run_deliver_beta_backend_administration >>
-    deliver_production_backend_administration:
-        jobs:
-            - bump_version:
-                context:
-                    - deliverino
-                platforms: web
-                prepare_delivery: true
-            - check_administration
-            - build_administration:
-                requires:
-                    - check_administration
-                    - bump_version
-            - pack_administration:
-                requires:
-                    - build_administration
-            - build_martin
-            - check_backend
-            - build_backend:
-                requires:
-                    - check_backend
-            - pack_backend:
-                requires:
-                    - build_backend
-                    - bump_version
-            - check_health_backend:
-                requires:
-                    - pack_backend
-            - pack_martin:
-                requires:
-                    - build_martin
-                    - bump_version
-            - pack_meta:
-                requires:
-                    - bump_version
-            - upload_packages_to_server:
-                bundle: administration
-                context:
-                    - credentials-ehrenamtskarte
-                name: upload_administration_packages_to_server_production
-                production: true
-                requires:
-                    - pack_administration
-                    - check_health_backend
-                    - pack_martin
-                    - pack_meta
-            - upload_packages_to_server:
-                bundle: backend
-                context:
-                    - credentials-ehrenamtskarte
-                name: upload_backend_packages_to_server_production
-                production: true
-                requires:
-                    - pack_administration
-                    - check_health_backend
-                    - pack_martin
-                    - pack_meta
-            - install_packages_to_server:
-                context:
-                    - credentials-ehrenamtskarte
-                name: install_packages_to_server_production
-                production: true
-                requires:
-                    - upload_administration_packages_to_server_production
-                    - upload_backend_packages_to_server_production
-            - notify_release:
-                context:
-                    - deliverino
-                production_delivery: true
-                requires:
-                    - install_packages_to_server_production
-        when: << pipeline.parameters.run_deliver_production_backend_administration >>
+        when: << pipeline.parameters.run_delivery_beta_backend_administration >>
     delivery_beta_native:
         jobs:
             - bump_version:

diff --git a/.circleci/src/@common.yml b/.circleci/src/@common.yml
@@ -12,10 +12,10 @@ parameters:
     default: "run_if_on_main"
     type: enum
     enum: ["run_if_on_main", "run", "skip"]
-  run_deliver_beta_backend_administration:
+  run_delivery_beta_backend_administration:
     default: false
     type: boolean
-  run_deliver_production_backend_administration:
+  run_delivery_production_backend_administration:
     default: false
     type: boolean
   run_frontend:

diff --git a/.circleci/src/workflows/deliver_production_backend_administration.yml b/.circleci/src/workflows/deliver_production_backend_administration.yml
@@ -1,5 +1,5 @@
-# Please use the deliver_beta_backend_administration and promote_backend_administration workflows. This is just for emergencies.
-when: << pipeline.parameters.run_deliver_production_backend_administration >>
+# Please use the delivery_beta_backend_administration and promote_backend_administration workflows. This is just for emergencies.
+when: << pipeline.parameters.run_delivery_production_backend_administration >>
 jobs:
   - bump_version:
       prepare_delivery: true

diff --git a/.circleci/src/workflows/deliver_beta_all.yml → ...cleci/src/workflows/delivery_beta_all.yml b/.circleci/src/workflows/deliver_beta_all.yml → ...cleci/src/workflows/delivery_beta_all.yml
diff --git a/...s/deliver_beta_backend_administration.yml → .../delivery_beta_backend_administration.yml b/...s/deliver_beta_backend_administration.yml → .../delivery_beta_backend_administration.yml
@@ -1,4 +1,4 @@
-when: << pipeline.parameters.run_deliver_beta_backend_administration >>
+when: << pipeline.parameters.run_delivery_beta_backend_administration >>
 jobs:
   - bump_version:
       prepare_delivery: true

diff --git a/README.md b/README.md
@@ -14,7 +14,8 @@
 
 ## Documentation
 
-* [Production Setup](./docs/production-setup.md)
+* [Manual Releases](./docs/manual-release)
+* [CI/CD](./docs/cicd.md)
 * [GraphQL Code Generation](./docs/graphql_generation.md)
 * [Protobuf Code Generation](./docs/protobuf-generation.md)
 * [Migrations](./docs/migrations.md)