Merge pull request #18 from code0-tech/17-release-coordination-implement-canary-releases

Start implementation of canary release

Author: Taucher2003

.gitignore

@@ -2,7 +2,8 @@
 /doc/
 /log/*.log
 /pkg/
-/tmp/
+/tmp/*
+!/tmp/.gitkeep
 /private/
 
 # rspec failure tracking

.gitlab-ci.yml

@@ -1,6 +1,10 @@
+include:
+  - local: .gitlab/ci/release-coordinator.canary.gitlab-ci.yml
+
 stages:
   - build
   - components
+  - !reference [.release-coordinator:canary:stages]
 
 default:
   image: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA

.gitlab/ci/release-coordinator.canary.gitlab-ci.yml

@@ -0,0 +1,78 @@
+.release-coordinator:canary:stages:
+  - release-coordinator:canary:build
+  - release-coordinator:canary:publish
+
+.release-coordinator:canary:
+  rules:
+    - if: $RELEASE_COORDINATOR == "canary"
+
+release-coordinator:canary:tmp-branch:
+  extends:
+    - .release-coordinator:canary
+  stage: release-coordinator:canary:build
+  script:
+    - bin/pyxis internal release_canary_tmp_branch --build-id-to-promote $BUILD_ID_TO_PROMOTE
+  variables:
+    DRY_RUN: "false"
+  artifacts:
+    reports:
+      dotenv: tmp/reticulum_variables.env
+
+release-coordinator:canary:build:
+  extends:
+    - .release-coordinator:canary
+  stage: release-coordinator:canary:build
+  needs:
+    - release-coordinator:canary:tmp-branch
+  trigger:
+    project: code0-tech/development/reticulum
+    branch: pyxis/canary-build/$BUILD_ID_TO_PROMOTE
+    forward:
+      pipeline_variables: true
+    strategy: depend
+  variables:
+    RETICULUM_BUILD_TYPE: canary
+
+release-coordinator:canary:tmp-branch-cleanup:
+  extends:
+    - .release-coordinator:canary
+  stage: release-coordinator:canary:build
+  needs:
+    - release-coordinator:canary:build
+  script:
+    - bin/pyxis internal release_canary_tmp_branch_cleanup --build-id-to-promote $BUILD_ID_TO_PROMOTE
+  variables:
+    DRY_RUN: "false"
+  when: always
+
+release-coordinator:canary:publish:
+  extends:
+    - .release-coordinator:canary
+  stage: release-coordinator:canary:publish
+  needs:
+    - release-coordinator:canary:build
+  script:
+    - echo "Publishing approved"
+  when: manual
+
+release-coordinator:canary:publish-containers:
+  extends:
+    - .release-coordinator:canary
+  stage: release-coordinator:canary:publish
+  needs:
+    - release-coordinator:canary:publish
+  script:
+    - bin/pyxis internal release_canary_publish_tags --coordinator-pipeline-id $CI_PIPELINE_ID
+  variables:
+    DRY_RUN: "false"
+
+release-coordinator:canary:publish-release:
+  extends:
+    - .release-coordinator:canary
+  stage: release-coordinator:canary:publish
+  needs:
+    - release-coordinator:canary:publish-containers
+  script:
+    - bin/pyxis internal release_canary_publish_release --coordinator-pipeline-id $CI_PIPELINE_ID
+  variables:
+    DRY_RUN: "false"

Gemfile

@@ -13,7 +13,7 @@ gem 'jwt', '~> 2.10'
 gem 'octokit', '~> 10.0'
 gem 'openssl', '~> 3.3'
 
-gem 'semantic_logger', '~> 4.16'
+gem 'semantic_logger', '~> 4.16', require: 'semantic_logger/sync'
 
 gem 'json', '~> 2.12'
 

lib/pyxis/cli.rb

@@ -5,7 +5,13 @@ class Cli < Thor
     desc 'components', 'Commands managing projects under managed versioning'
     subcommand 'components', Pyxis::Commands::Components
 
-    def self.exit_on_failure?
+    desc 'release', 'Commands managing the release process'
+    subcommand 'release', Pyxis::Commands::Release
+
+    desc 'internal', 'Internal commands for usage by the pipeline', hide: true
+    subcommand 'internal', Pyxis::Commands::Internal
+
+    def Thor.exit_on_failure?
       true
     end
   end

lib/pyxis/commands/components.rb

@@ -71,7 +71,7 @@ def update
       def list
         result = 'Available components:'
         Pyxis::Project.components.each do |project|
-          result += "\n- #{project.downcase}"
+          result += "\n- #{project}"
         end
         result
       end

lib/pyxis/commands/internal.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pyxis
+  module Commands
+    class Internal < Thor
+      include Thor::Actions
+
+      desc 'release_canary_tmp_branch', ''
+      method_option :build_id_to_promote, required: true, type: :numeric
+      def release_canary_tmp_branch
+        Pyxis::Release::Canary.new.create_build_branch(options[:build_id_to_promote])
+      end
+
+      desc 'release_canary_tmp_branch_cleanup', ''
+      method_option :build_id_to_promote, required: true, type: :numeric
+      def release_canary_tmp_branch_cleanup
+        Pyxis::Release::Canary.new.remove_build_branch(options[:build_id_to_promote])
+      end
+
+      desc 'release_canary_publish_tags', ''
+      method_option :coordinator_pipeline_id, required: true, type: :numeric
+      def release_canary_publish_tags
+        Pyxis::Release::Canary.new.publish_tags(options[:coordinator_pipeline_id])
+      end
+
+      desc 'release_canary_publish_release', ''
+      method_option :coordinator_pipeline_id, required: true, type: :numeric
+      def release_canary_publish_release
+        Pyxis::Release::Canary.new.publish_release(options[:coordinator_pipeline_id])
+      end
+    end
+  end
+end

lib/pyxis/commands/release.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Pyxis
+  module Commands
+    class Release < Thor
+      include PermissionHelper
+
+      desc 'create_canary', 'Promote an experimental build to canary'
+      exclusive do
+        at_least_one do
+          method_option :build,
+                        aliases: '-b',
+                        desc: 'The build ID',
+                        required: false,
+                        type: :numeric
+          method_option :container_tag,
+                        aliases: '-c',
+                        desc: 'The container tag excluding variant modifiers',
+                        required: false,
+                        type: :string
+        end
+      end
+      def create_canary
+        assert_executed_by_delivery_team_member!
+
+        build_id = options[:build] || ManagedVersioning::ComponentInfo.new(
+          container_tag: options[:container_tag]
+        ).find_build_id_for_container_tag
+
+        raise Pyxis::MessageError, 'This build does not exist' if build_id.nil?
+
+        pipeline = GitlabClient.client.create_pipeline(
+          Project::Pyxis.api_gitlab_path,
+          Project::Pyxis.default_branch,
+          variables: {
+            RELEASE_COORDINATOR: 'canary',
+            BUILD_ID_TO_PROMOTE: build_id.to_s,
+          }
+        )
+
+        raise Pyxis::MessageError, 'Failed to create pipeline' if pipeline.response.status != 201
+
+        "Created coordinator pipeline at #{pipeline.body.web_url}"
+      end
+    end
+  end
+end

lib/pyxis/environment.rb

@@ -16,6 +16,10 @@ def github_release_tools_approver_private_key
       File.read(ENV.fetch('PYXIS_GH_RELEASE_TOOLS_APPROVER_PRIVATE_KEY'))
     end
 
+    def github_reticulum_publish_token
+      File.read(ENV.fetch('PYXIS_GH_RETICULUM_PUBLISH_TOKEN'))
+    end
+
     def gitlab_release_tools_token
       File.read(ENV.fetch('PYXIS_GL_RELEASE_TOOLS_PRIVATE_TOKEN'))
     end

lib/pyxis/github_client.rb

@@ -4,6 +4,8 @@ module Pyxis
   class GithubClient
     include SemanticLogger::Loggable
 
+    ORGANIZATION_NAME = 'code0-tech'
+
     CLIENT_CONFIGS = {
       release_tools: {
         app_id: 857194,