fastlane-plugin-circle_ci 0.1.0 → 0.3.0

data/lib/fastlane/plugin/circle_ci/actions/circleci_set_env_var.rb

@@ -0,0 +1,102 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    class CircleciSetEnvVarAction < Action
+      def self.run(params)
+        UI.message("Setting environment variable for CircleCI project via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        name = params[:name]
+        value = params[:value]
+        
+        # Create request body
+        body = {
+          name: name,
+          value: value
+        }
+        
+        # Make API request
+        result = Helper::CircleCiHelper.post_v2("project/#{project_slug}/envvar", api_token, body)
+        
+        UI.success("Successfully set environment variable '#{name}' for project #{project_slug}")
+        
+        return result
+      end
+
+      def self.description
+        "Sets an environment variable for a CircleCI project using API v2"
+      end
+
+      def self.details
+        "This action sets an environment variable for a specific CircleCI project using the CircleCI API v2."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_slug,
+                                       env_name: "CIRCLE_CI_PROJECT_SLUG",
+                                       description: "Project slug in the form of :vcs-type/:org-name/:project-name (e.g. github/myorg/myrepo)",
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_PROJECT_SLUG"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       env_name: "CIRCLE_CI_ENV_VAR_NAME",
+                                       description: "Name of the environment variable to set",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                       env_name: "CIRCLE_CI_ENV_VAR_VALUE",
+                                       description: "Value of the environment variable to set",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.return_value
+        "Returns the API response containing the name and masked value of the set environment variable."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_set_env_var(
+            project_slug: "github/myorg/myrepo",
+            name: "API_KEY",
+            value: "secret-api-key"
+          )',
+          'circleci_set_env_var(
+            project_slug: "github/myorg/myrepo",
+            name: "DEPLOY_ENVIRONMENT",
+            value: "production"
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_trigger_pipeline.rb

@@ -0,0 +1,130 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_PIPELINE_ID = :CIRCLECI_PIPELINE_ID
+      CIRCLECI_PIPELINE_NUMBER = :CIRCLECI_PIPELINE_NUMBER
+      CIRCLECI_PIPELINE_URL = :CIRCLECI_PIPELINE_URL
+    end
+
+    class CircleciTriggerPipelineAction < Action
+      def self.run(params)
+        UI.message("Triggering CircleCI pipeline via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        branch = params[:branch]
+        parameters = params[:parameters] || {}
+        
+        # Create request body
+        body = {
+          branch: branch
+        }
+
+        # Add parameters if they exist
+        body[:parameters] = parameters unless parameters.empty?
+        
+        # Make API request
+        result = Helper::CircleCiHelper.post_v2("project/#{project_slug}/pipeline", api_token, body)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_PIPELINE_ID] = result["id"]
+        Actions.lane_context[SharedValues::CIRCLECI_PIPELINE_NUMBER] = result["number"]
+        
+        # Create pipeline URL
+        vcs_info = project_slug.split('/')
+        pipeline_url = "https://app.circleci.com/pipelines/#{vcs_info[0]}/#{vcs_info[1]}/#{vcs_info[2]}/#{result["number"]}"
+        Actions.lane_context[SharedValues::CIRCLECI_PIPELINE_URL] = pipeline_url
+        
+        UI.success("Successfully triggered CircleCI pipeline ##{result["number"]} with ID #{result["id"]}")
+        UI.success("Pipeline URL: #{pipeline_url}")
+        
+        return result
+      end
+
+      def self.description
+        "Triggers a CircleCI pipeline using API v2"
+      end
+
+      def self.details
+        "This action triggers a CircleCI pipeline using the CircleCI API v2. It allows you to specify branch and parameters for the pipeline run."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_slug,
+                                       env_name: "CIRCLE_CI_PROJECT_SLUG",
+                                       description: "Project slug in the form of :vcs-type/:org-name/:project-name (e.g. github/myorg/myrepo)",
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_PROJECT_SLUG"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                       env_name: "CIRCLE_CI_BRANCH",
+                                       description: "The branch to trigger a pipeline on",
+                                       is_string: true,
+                                       default_value: "main",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :parameters,
+                                       env_name: "CIRCLE_CI_PIPELINE_PARAMETERS",
+                                       description: "Pipeline parameters, must match parameters defined in the pipeline configuration",
+                                       is_string: false,
+                                       default_value: {},
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_PIPELINE_ID', 'The ID of the triggered pipeline'],
+          ['CIRCLECI_PIPELINE_NUMBER', 'The number of the triggered pipeline'],
+          ['CIRCLECI_PIPELINE_URL', 'The URL of the triggered pipeline']
+        ]
+      end
+
+      def self.return_value
+        "Returns the full API response from CircleCI API"
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_trigger_pipeline(
+            project_slug: "github/myorg/myrepo",
+            branch: "main",
+            parameters: {
+              "deploy_env" => "staging",
+              "run_integration_tests" => true
+            }
+          )',
+          'circleci_trigger_pipeline(
+            project_slug: "github/myorg/myrepo",
+            branch: "feature/my-branch"
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_update_pipeline_definition.rb

@@ -0,0 +1,127 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_UPDATED_PIPELINE_DEFINITION = :CIRCLECI_UPDATED_PIPELINE_DEFINITION
+    end
+
+    class CircleciUpdatePipelineDefinitionAction < Action
+      def self.run(params)
+        UI.message("Updating CircleCI pipeline definition via API v2...")
+        
+        api_token = params[:api_token]
+        project_id = params[:project_id]
+        pipeline_definition_id = params[:pipeline_definition_id]
+        
+        # Build the request body with only provided parameters
+        body = {}
+        body["name"] = params[:name] if params[:name]
+        body["description"] = params[:description] if params[:description]
+        body["config_source"] = params[:config_source] if params[:config_source]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.patch_v2("projects/#{project_id}/pipeline-definitions/#{pipeline_definition_id}", api_token, body)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_UPDATED_PIPELINE_DEFINITION] = result
+        
+        UI.success("Successfully updated pipeline definition with ID #{pipeline_definition_id}")
+        
+        return result
+      end
+
+      def self.description
+        "Updates a pipeline definition in CircleCI using API v2"
+      end
+
+      def self.details
+        "This action updates an existing pipeline definition in CircleCI using the CircleCI API v2. Currently only supported for pipeline definitions where config_source.provider is github_app or bitbucket_dc."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "CIRCLE_CI_PROJECT_ID",
+                                       description: "The ID of the CircleCI project",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :pipeline_definition_id,
+                                       description: "The ID of the pipeline definition to update",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       description: "New name for the pipeline definition",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :description,
+                                       description: "New description for the pipeline definition",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :config_source,
+                                       description: "New configuration source for the pipeline definition",
+                                       type: Hash,
+                                       optional: true,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("config_source must contain 'provider'") unless value["provider"]
+                                       end)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_UPDATED_PIPELINE_DEFINITION', 'A hash containing the updated pipeline definition information']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing the updated pipeline definition information."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_update_pipeline_definition(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            pipeline_definition_id: "fedcba98-7654-3210-fedc-ba9876543210",
+            name: "Updated Pipeline Definition Name"
+          )',
+          'updated_definition = circleci_update_pipeline_definition(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            pipeline_definition_id: "fedcba98-7654-3210-fedc-ba9876543210",
+            description: "Updated pipeline definition description",
+            config_source: {
+              "provider" => "github_app",
+              "config_path" => ".circleci/updated-config.yml",
+              "branch" => "feature/new-branch"
+            }
+          )
+          
+          # Use the updated pipeline definition
+          UI.message("Updated definition name: #{updated_definition["name"]}")'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_update_pipeline_schedule.rb

@@ -0,0 +1,134 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_UPDATED_SCHEDULE = :CIRCLECI_UPDATED_SCHEDULE
+    end
+
+    class CircleciUpdatePipelineScheduleAction < Action
+      def self.run(params)
+        UI.message("Updating CircleCI pipeline schedule via API v2...")
+        
+        api_token = params[:api_token]
+        schedule_id = params[:schedule_id]
+        
+        # Build the request body with only provided parameters
+        body = {}
+        body["description"] = params[:description] if params[:description]
+        body["name"] = params[:name] if params[:name]
+        body["parameters"] = params[:parameters] if params[:parameters]
+        body["timetable"] = params[:timetable] if params[:timetable]
+        body["attribution-actor"] = params[:attribution_actor] if params[:attribution_actor]
+        body["active"] = params[:active] unless params[:active].nil?
+        
+        # Make API request
+        result = Helper::CircleCiHelper.patch_v2("schedule/#{schedule_id}", api_token, body)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_UPDATED_SCHEDULE] = result
+        
+        UI.success("Successfully updated pipeline schedule with ID #{schedule_id}")
+        
+        return result
+      end
+
+      def self.description
+        "Updates a pipeline schedule in CircleCI using API v2"
+      end
+
+      def self.details
+        "This action updates an existing pipeline schedule in CircleCI using the CircleCI API v2. You can update various properties such as name, description, parameters, and timetable."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :schedule_id,
+                                       description: "The UUID of the schedule to update",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :description,
+                                       description: "Description of the schedule",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :name,
+                                       description: "Name of the schedule",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :parameters,
+                                       description: "Pipeline parameters (e.g. branch, tag)",
+                                       type: Hash,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :timetable,
+                                       description: "Timetable definition for the schedule (e.g. hours, days-of-week, etc.)",
+                                       type: Hash,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :attribution_actor,
+                                       description: "The attribution-actor field for the scheduled pipeline",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :active,
+                                       description: "Whether the schedule is active",
+                                       is_string: false,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_UPDATED_SCHEDULE', 'A hash containing the updated schedule information']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing the updated schedule information."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_update_pipeline_schedule(
+            schedule_id: "8a3eb5ac-8666-451b-8bfc-1ee10e46c81e",
+            name: "Updated Nightly Build",
+            description: "Runs every night at midnight",
+            parameters: {
+              "branch" => "main"
+            },
+            active: false
+          )',
+          '# Get a more detailed timetable
+          updated_schedule = circleci_update_pipeline_schedule(
+            schedule_id: "8a3eb5ac-8666-451b-8bfc-1ee10e46c81e",
+            timetable: {
+              "per-hour" => 1,
+              "hours-of-day" => [0, 12],
+              "days-of-week" => ["MON", "WED", "FRI"],
+              "time-zone" => "America/New_York"
+            }
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/circle_ci/actions/circleci_update_trigger.rb

@@ -0,0 +1,114 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_UPDATED_TRIGGER = :CIRCLECI_UPDATED_TRIGGER
+    end
+
+    class CircleciUpdateTriggerAction < Action
+      def self.run(params)
+        UI.message("Updating CircleCI trigger via API v2...")
+        
+        api_token = params[:api_token]
+        project_id = params[:project_id]
+        trigger_id = params[:trigger_id]
+        
+        # Build the request body with only provided parameters
+        body = {}
+        body["description"] = params[:description] if params[:description]
+        body["config"] = params[:config] if params[:config]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.patch_v2("projects/#{project_id}/triggers/#{trigger_id}", api_token, body)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_UPDATED_TRIGGER] = result
+        
+        UI.success("Successfully updated trigger with ID #{trigger_id}")
+        
+        return result
+      end
+
+      def self.description
+        "Updates a trigger in CircleCI using API v2"
+      end
+
+      def self.details
+        "This action updates an existing trigger in CircleCI using the CircleCI API v2. You can update the description and configuration of the trigger."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :api_token,
+                                       env_name: "CIRCLE_CI_API_TOKEN",
+                                       description: "API Token for CircleCI API",
+                                       sensitive: true,
+                                       code_gen_sensitive: true,
+                                       is_string: true,
+                                       default_value: ENV["CIRCLE_CI_API_TOKEN"],
+                                       default_value_dynamic: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :project_id,
+                                       env_name: "CIRCLE_CI_PROJECT_ID",
+                                       description: "The ID of the CircleCI project",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :trigger_id,
+                                       description: "The ID of the trigger to update",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :description,
+                                       description: "Updated description for the trigger",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :config,
+                                       description: "Updated configuration for the trigger (varies by trigger type)",
+                                       type: Hash,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_UPDATED_TRIGGER', 'A hash containing the updated trigger information']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing the updated trigger information."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_update_trigger(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            trigger_id: "fedcba98-7654-3210-fedc-ba9876543210",
+            description: "Updated webhook trigger description"
+          )',
+          'updated_trigger = circleci_update_trigger(
+            project_id: "01234567-89ab-cdef-0123-456789abcdef",
+            trigger_id: "fedcba98-7654-3210-fedc-ba9876543210",
+            description: "Updated GitHub PR Trigger",
+            config: {
+              "targetBranchMatchers" => ["main", "develop/*", "feature/*"]
+            }
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end