fastlane-plugin-circle_ci 0.2.0 → 0.3.0

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

@@ -0,0 +1,123 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_WORKFLOW_JOB_METRICS = :CIRCLECI_WORKFLOW_JOB_METRICS
+    end
+
+    class CircleciGetWorkflowJobMetricsAction < Action
+      def self.run(params)
+        UI.message("Getting job metrics for CircleCI workflow 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["reporting-window"] = params[:reporting_window] if params[:reporting_window]
+        query_params["page-token"] = params[:page_token] if params[:page_token]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("insights/#{project_slug}/workflows/#{workflow_name}/jobs", api_token, query_params)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_WORKFLOW_JOB_METRICS] = result
+        
+        UI.success("Successfully retrieved job metrics for workflow #{workflow_name}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets summary metrics for a project workflow's jobs using Insights API v2"
+      end
+
+      def self.details
+        "This action retrieves summary metrics for a project workflow's jobs using the CircleCI Insights API v2. Job runs going back at most 90 days are included in the aggregation window. Metrics are refreshed daily, and thus may not include executions from the last 24 hours."
+      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: :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: :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: :page_token,
+                                       description: "A token to retrieve the next page of results",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_WORKFLOW_JOB_METRICS', 'A hash containing job metrics for the workflow']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing job metrics for the workflow."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_workflow_job_metrics(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test"
+          )',
+          'job_metrics = circleci_get_workflow_job_metrics(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test",
+            branch: "main",
+            reporting_window: "last-30-days"
+          )
+          
+          # Access the job metrics
+          job_metrics["items"].each do |job|
+            UI.message("Job: #{job["name"]}, Success Rate: #{job["success_rate"]}, Duration: #{job["duration_metrics"]["median"]}ms")
+          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_workflow_jobs.rb

@@ -0,0 +1,109 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_WORKFLOW_JOBS = :CIRCLECI_WORKFLOW_JOBS
+    end
+
+    class CircleciGetWorkflowJobsAction < Action
+      def self.run(params)
+        UI.message("Getting CircleCI workflow jobs via API v2...")
+        
+        api_token = params[:api_token]
+        workflow_id = params[:workflow_id]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("workflow/#{workflow_id}/job", api_token)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_WORKFLOW_JOBS] = result["items"]
+        
+        UI.success("Successfully retrieved #{result["items"].count} jobs for workflow #{workflow_id}")
+        
+        return result["items"]
+      end
+
+      def self.description
+        "Gets jobs for a CircleCI workflow using API v2"
+      end
+
+      def self.details
+        "This action retrieves all jobs for a specific CircleCI workflow using the CircleCI API v2, including status, job numbers, and names."
+      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: :workflow_id,
+                                       env_name: "CIRCLE_CI_WORKFLOW_ID",
+                                       description: "The ID of the workflow to get jobs for",
+                                       is_string: true,
+                                       optional: false)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_WORKFLOW_JOBS', 'An array of job data for the workflow']
+        ]
+      end
+
+      def self.return_value
+        "Returns an array of job data including job numbers, names, and status information."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_workflow_jobs(
+            workflow_id: "workflow-uuid"
+          )',
+          'jobs = circleci_get_workflow_jobs(
+            workflow_id: "workflow-uuid"
+          )
+          
+          # Find jobs by status
+          failed_jobs = jobs.select { |job| job["status"] == "failed" }
+          
+          if failed_jobs.any?
+            UI.error("There are #{failed_jobs.count} failed jobs in this workflow")
+            failed_jobs.each do |job|
+              puts "  - #{job["name"]}: #{job["status"]}"
+            end
+          end
+          
+          # Find a specific job
+          test_job = jobs.find { |job| job["name"] == "run-tests" }
+          if test_job
+            # Get detailed job information
+            job_details = circleci_get_job_details(
+              project_slug: "github/myorg/myrepo",
+              job_number: test_job["job_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_workflow_runs.rb

@@ -0,0 +1,129 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_WORKFLOW_RUNS = :CIRCLECI_WORKFLOW_RUNS
+    end
+
+    class CircleciGetWorkflowRunsAction < Action
+      def self.run(params)
+        UI.message("Getting recent workflow runs 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["start-date"] = params[:start_date] if params[:start_date]
+        query_params["end-date"] = params[:end_date] if params[:end_date]
+        query_params["page-token"] = params[:page_token] if params[:page_token]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("insights/#{project_slug}/workflows/#{workflow_name}", api_token, query_params)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_WORKFLOW_RUNS] = result
+        
+        UI.success("Successfully retrieved recent runs for workflow #{workflow_name}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets recent runs of a workflow using Insights API v2"
+      end
+
+      def self.details
+        "This action retrieves recent runs of a workflow using the CircleCI Insights API v2. Runs going back at most 90 days are returned."
+      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: :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: :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),
+          FastlaneCore::ConfigItem.new(key: :page_token,
+                                       description: "A token to retrieve the next page of results",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_WORKFLOW_RUNS', 'A hash containing recent workflow runs']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing recent workflow runs."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_workflow_runs(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test"
+          )',
+          'runs = circleci_get_workflow_runs(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test",
+            branch: "main",
+            start_date: "2025-01-01",
+            end_date: "2025-04-29"
+          )
+          
+          # Access the workflow runs
+          runs["items"].each do |run|
+            UI.message("Run ID: #{run["id"]}, Status: #{run["status"]}, Started: #{run["created_at"]}")
+          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_workflow_summary.rb

@@ -0,0 +1,118 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_WORKFLOW_SUMMARY = :CIRCLECI_WORKFLOW_SUMMARY
+    end
+
+    class CircleciGetWorkflowSummaryAction < Action
+      def self.run(params)
+        UI.message("Getting workflow summary metrics 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["reporting-window"] = params[:reporting_window] if params[:reporting_window]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("insights/#{project_slug}/workflows/#{workflow_name}/summary", api_token, query_params)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_WORKFLOW_SUMMARY] = result
+        
+        UI.success("Successfully retrieved summary metrics for workflow #{workflow_name}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets metrics and trends for a workflow using Insights API v2"
+      end
+
+      def self.details
+        "This action retrieves metrics and trends for a particular workflow on a single branch or all branches 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: :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: :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: :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)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_WORKFLOW_SUMMARY', 'A hash containing workflow summary metrics and trends']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing workflow summary metrics and trends."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_workflow_summary(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test"
+          )',
+          'summary = circleci_get_workflow_summary(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test",
+            branch: "main",
+            reporting_window: "last-30-days"
+          )
+          
+          # Access the workflow summary metrics
+          UI.message("Total Runs: #{summary["total_runs"]}")
+          UI.message("Success Rate: #{summary["success_rate"]}%")
+          UI.message("Median Duration: #{summary["duration_metrics"]["median"]} ms")'
+        ]
+      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_workflow_test_metrics.rb

@@ -0,0 +1,115 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_WORKFLOW_TEST_METRICS = :CIRCLECI_WORKFLOW_TEST_METRICS
+    end
+
+    class CircleciGetWorkflowTestMetricsAction < Action
+      def self.run(params)
+        UI.message("Getting test metrics for CircleCI workflow 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["page-token"] = params[:page_token] if params[:page_token]
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("insights/#{project_slug}/workflows/#{workflow_name}/test-metrics", api_token, query_params)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_WORKFLOW_TEST_METRICS] = result
+        
+        UI.success("Successfully retrieved test metrics for workflow #{workflow_name}")
+        
+        return result
+      end
+
+      def self.description
+        "Gets test metrics for a project workflow using Insights API v2"
+      end
+
+      def self.details
+        "This action retrieves test metrics for a project workflow using the CircleCI Insights API v2. Currently test metrics are calculated based on the 10 most recent workflow runs."
+      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: :page_token,
+                                       description: "A token to retrieve the next page of results",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_WORKFLOW_TEST_METRICS', 'A hash containing test metrics for the workflow']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing test metrics for the workflow."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_get_workflow_test_metrics(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test"
+          )',
+          'test_metrics = circleci_get_workflow_test_metrics(
+            project_slug: "gh/MyOrg/my-project",
+            workflow_name: "build-and-test",
+            branch: "main"
+          )
+          
+          # Access the test metrics
+          test_metrics["items"].each do |test_suite|
+            UI.message("Test Suite: #{test_suite["test_counts"]["total"]} tests, #{test_suite["test_counts"]["fail"]} failures")
+          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_list_all_pipelines.rb

@@ -0,0 +1,94 @@
+require 'fastlane/action'
+require_relative '../helper/circle_ci_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      CIRCLECI_ALL_PIPELINES = :CIRCLECI_ALL_PIPELINES
+    end
+
+    class CircleciListAllPipelinesAction < Action
+      def self.run(params)
+        UI.message("Getting all CircleCI pipelines via API v2...")
+        
+        api_token = params[:api_token]
+        org_slug = params[:org_slug]
+        
+        query_params = {}
+        query_params["org-slug"] = org_slug if org_slug
+        
+        # Make API request
+        result = Helper::CircleCiHelper.get_v2("pipeline", api_token, query_params)
+        
+        # Store values in lane context
+        Actions.lane_context[SharedValues::CIRCLECI_ALL_PIPELINES] = result
+        
+        UI.success("Successfully retrieved all pipelines")
+        
+        return result
+      end
+
+      def self.description
+        "Gets a list of all pipelines across projects using CircleCI API v2"
+      end
+
+      def self.details
+        "This action retrieves all pipelines for the most recently built projects (max 250) you follow in an organization 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: :org_slug,
+                                       description: "The organization slug (optional, for filtering by organization)",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      def self.output
+        [
+          ['CIRCLECI_ALL_PIPELINES', 'A hash containing all pipelines information']
+        ]
+      end
+
+      def self.return_value
+        "Returns a hash containing information about all pipelines."
+      end
+
+      def self.authors
+        ["crazymanish", "copilot"]
+      end
+
+      def self.example_code
+        [
+          'circleci_list_all_pipelines',
+          'pipelines = circleci_list_all_pipelines(
+            org_slug: "gh/MyOrg"
+          )
+          
+          # Process the pipelines
+          pipelines["items"].each do |pipeline|
+            UI.message("Pipeline ID: #{pipeline["id"]}, Created: #{pipeline["created_at"]}")
+          end'
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :ci
+      end
+    end
+  end
+end