fastlane-plugin-circle_ci 0.1.0 → 0.3.0

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

@@ -0,0 +1,131 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_JOB_TIMESERIES = :CIRCLECI_JOB_TIMESERIES
+    end
+
+    class CircleciGetJobTimeseriesAction < Action
+      def self.run(params)
+        UI.message("Getting job timeseries data via Insights API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        workflow_name = params[:workflow_name]
+        
+        # Build query parameters
+        query_params = {}
+        query_params["branch"] = params[:branch] if params[:branch]
+        query_params["granularity"] = params[:granularity] if params[:granularity]
+        query_params["start-date"] = params[:start_date] if params[:start_date]
+        query_params["end-date"] = params[:end_date] if params[:end_date]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("insights/time-series/#{project_slug}/workflows/#{workflow_name}/jobs", api_token, query_params)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_JOB_TIMESERIES] = result
+        
+        UI.success("Successfully retrieved job timeseries data for workflow #{workflow_name}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets timeseries data for all jobs within a workflow using Insights API v2"
+      end
+
+      def self.details
+        "This action retrieves timeseries data for all jobs within a workflow using the CircleCI Insights API v2. Hourly granularity data is only retained for 48 hours while daily granularity data is retained for 90 days."
+      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 vcs-slug/org-name/repo-name",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :workflow_name,
+                                       description: "The name of the workflow",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :branch,
+                                       description: "The name of a branch to filter for",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :granularity,
+                                       description: "The granularity of timeseries data points (hourly, daily, etc.)",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :start_date,
+                                       description: "Include only executions that started at or after this date (format: YYYY-MM-DD)",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :end_date,
+                                       description: "Include only executions that started before this date (format: YYYY-MM-DD)",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_JOB_TIMESERIES', 'An array of timeseries data, one entry per job']
+        ]
+      end
+
+      def self.return_value
+        "Returns an array of timeseries data, one entry per job."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_job_timeseries(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test"
+          )',
+          'timeseries_data = circleci_get_job_timeseries(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test",
+            branch: "main",
+            granularity: "daily",
+            start_date: "2025-01-01",
+            end_date: "2025-04-29"
+          )
+          
+          # Process the timeseries data
+          timeseries_data["items"].each do |job_data|
+            UI.message("Job: #{job_data["name"]}")
+            job_data["metrics"].each do |metric|
+              UI.message("  #{metric["timestamp"]}: #{metric["total_runs"]} runs, #{metric["success_rate"]}% success rate")
+            end
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_MY_PIPELINES = :CIRCLECI_MY_PIPELINES
+    end
+
+    class CircleciGetMyPipelinesAction < Action
+      def self.run(params)
+        UI.message("Getting recent CircleCI pipelines for current user via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("project/#{project_slug}/pipeline/mine", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_MY_PIPELINES] = result["items"]
+        
+        UI.success("Successfully retrieved #{result["items"].count} recent pipelines for current user")
+        
+        return result["items"]
+      end
+
+      def self.description
+        "Gets recent pipelines for the current user from CircleCI using API v2"
+      end
+
+      def self.details
+        "This action retrieves recent pipelines triggered by or associated with the current user from CircleCI 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,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_MY_PIPELINES', 'An array of pipeline data for the current user']
+        ]
+      end
+
+      def self.return_value
+        "Returns an array of pipeline data including IDs, numbers, states, and created timestamps."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_my_pipelines(
+            project_slug: "github/myorg/myrepo"
+          )',
+          'my_pipelines = circleci_get_my_pipelines(
+            project_slug: "github/myorg/myrepo"
+          )
+          
+          # Print details of recent pipelines
+          my_pipelines.each do |pipeline|
+            puts "Pipeline ##{pipeline["number"]}: #{pipeline["state"]} (#{pipeline["created_at"]})"
+          end
+          
+          # Find a successful pipeline
+          success_pipeline = my_pipelines.find { |p| p["state"] == "success" }
+          if success_pipeline
+            puts "Latest successful pipeline: ##{success_pipeline["number"]}"
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_ORG_SUMMARY = :CIRCLECI_ORG_SUMMARY
+    end
+
+    class CircleciGetOrgSummaryAction < Action
+      def self.run(params)
+        UI.message("Getting organization summary metrics via Insights API v2...")
+        
+        api_token = params[:api_token]
+        org_slug = params[:org_slug]
+        
+        # Build query parameters
+        query_params = {}
+        query_params["reporting-window"] = params[:reporting_window] if params[:reporting_window]
+        query_params["project-names"] = params[:project_names].join(',') if params[:project_names]&.any?
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("insights/#{org_slug}/summary", api_token, query_params)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_ORG_SUMMARY] = result
+        
+        UI.success("Successfully retrieved summary metrics for organization #{org_slug}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets summary metrics with trends for an entire organization using Insights API v2"
+      end
+
+      def self.details
+        "This action retrieves aggregated summary metrics with trends for the entire organization and for each project belonging to the organization using the CircleCI Insights 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: :org_slug,
+                                       env_name: "CIRCLE_CI_ORG_SLUG",
+                                       description: "Organization slug (e.g., 'gh/MyOrg')",
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :reporting_window,
+                                       description: "The time window used to calculate summary metrics (last-24-hours, last-7-days, last-90-days, etc.)",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :project_names,
+                                       description: "List of project names to include in summary metrics",
+                                       type: Array,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_ORG_SUMMARY', 'A hash containing organization summary metrics with trends']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing organization summary metrics with trends."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_org_summary(
+            org_slug: "gh/MyOrg"
+          )',
+          'org_summary = circleci_get_org_summary(
+            org_slug: "gh/MyOrg",
+            reporting_window: "last-30-days",
+            project_names: ["project-1", "project-2"]
+          )
+          
+          # Access the organization summary metrics
+          UI.message("Total Credits Used: #{org_summary["org_data"]["metrics"]["total_credits_used"]}")
+          UI.message("Total Workflows: #{org_summary["org_data"]["metrics"]["total_runs"]}")
+          
+          # Access metrics for each project
+          org_summary["org_projects"].each do |project|
+            UI.message("Project: #{project["project_name"]}, Success Rate: #{project["metrics"]["success_rate"]}%")
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_PIPELINE = :CIRCLECI_PIPELINE
+    end
+
+    class CircleciGetPipelineAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI pipeline via API v2...")
+        
+        api_token = params[:api_token]
+        pipeline_id = params[:pipeline_id]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("pipeline/#{pipeline_id}", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_PIPELINE] = result
+        
+        UI.success("Successfully retrieved pipeline #{pipeline_id}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets information about a CircleCI pipeline using API v2"
+      end
+
+      def self.details
+        "This action retrieves detailed information about a specific CircleCI pipeline using the CircleCI API v2, including state, created timestamp, trigger information, and VCS data."
+      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: :pipeline_id,
+                                       env_name: "CIRCLE_CI_PIPELINE_ID",
+                                       description: "The ID of the pipeline to get information for",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_PIPELINE', 'A hash containing the pipeline details']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing detailed pipeline information including state, created timestamp, trigger information, and VCS data."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_pipeline(
+            pipeline_id: "pipeline-uuid"
+          )',
+          'pipeline = circleci_get_pipeline(
+            pipeline_id: "pipeline-uuid"
+          )
+          
+          # Print pipeline details
+          puts "Pipeline state: #{pipeline["state"]}"
+          puts "Created at: #{pipeline["created_at"]}"
+          puts "Trigger: #{pipeline["trigger"]["type"]}"
+          
+          # Check if pipeline is for a specific branch
+          if pipeline["vcs"] && pipeline["vcs"]["branch"] == "main"
+            UI.important("This is a main branch pipeline!")
+          end
+          
+          # Get workflows for this pipeline
+          workflows = circleci_get_pipeline_workflows(
+            pipeline_id: pipeline["id"]
+          )'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_PIPELINE_BY_NUMBER = :CIRCLECI_PIPELINE_BY_NUMBER
+    end
+
+    class CircleciGetPipelineByNumberAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI pipeline by number via API v2...")
+        
+        api_token = params[:api_token]
+        project_slug = params[:project_slug]
+        pipeline_number = params[:pipeline_number]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("project/#{project_slug}/pipeline/#{pipeline_number}", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_PIPELINE_BY_NUMBER] = result
+        
+        UI.success("Successfully retrieved pipeline number #{pipeline_number} for project #{project_slug}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets a specific pipeline by number from CircleCI using API v2"
+      end
+
+      def self.details
+        "This action retrieves details about a specific pipeline by its number from CircleCI 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: :pipeline_number,
+                                       env_name: "CIRCLE_CI_PIPELINE_NUMBER",
+                                       description: "The number of the pipeline to retrieve",
+                                       is_string: false,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_PIPELINE_BY_NUMBER', 'A hash containing the pipeline details']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing pipeline details including state, created timestamp, and trigger information."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_pipeline_by_number(
+            project_slug: "github/myorg/myrepo",
+            pipeline_number: 123
+          )',
+          'pipeline = circleci_get_pipeline_by_number(
+            project_slug: "github/myorg/myrepo",
+            pipeline_number: 123
+          )
+          
+          if pipeline["state"] == "success"
+            puts "Pipeline #{pipeline["number"]} completed successfully at #{pipeline["created_at"]}"
+          else
+            puts "Pipeline #{pipeline["number"]} is in state: #{pipeline["state"]}"
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_PIPELINE_CONFIG = :CIRCLECI_PIPELINE_CONFIG
+    end
+
+    class CircleciGetPipelineConfigAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI pipeline configuration via API v2...")
+        
+        api_token = params[:api_token]
+        pipeline_id = params[:pipeline_id]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("pipeline/#{pipeline_id}/config", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_PIPELINE_CONFIG] = result
+        
+        UI.success("Successfully retrieved configuration for pipeline #{pipeline_id}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets the configuration for a CircleCI pipeline using API v2"
+      end
+
+      def self.details
+        "This action retrieves the configuration for a specific CircleCI pipeline using the CircleCI API v2. The configuration includes the source and compiled YAML configuration files."
+      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: :pipeline_id,
+                                       description: "The ID of the pipeline to retrieve configuration for",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_PIPELINE_CONFIG', 'A hash containing the pipeline configuration information']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing pipeline configuration information including source and compiled configurations."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_pipeline_config(
+            pipeline_id: "01234567-89ab-cdef-0123-456789abcdef"
+          )',
+          'config = circleci_get_pipeline_config(
+            pipeline_id: "01234567-89ab-cdef-0123-456789abcdef"
+          )
+          
+          # Use the pipeline configuration information
+          UI.message("Source config: #{config["source"]}")
+          UI.message("Compiled config: #{config["compiled"]}")'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end