Merge branch...

Merge branch '299489-over-10-of-graphql-descriptions-are-missing-pipeline_status_enum' into 'master'

Add descriptions to PipelineStatusEnum

See merge request gitlab-org/gitlab!57876

app/graphql/types/ci/pipeline_status_enum.rb

@@ -4,7 +4,9 @@ module Types
   module Ci
     class PipelineStatusEnum < BaseEnum
       ::Ci::Pipeline.all_state_names.each do |state_symbol|
-        value state_symbol.to_s.upcase, value: state_symbol.to_s
+        value state_symbol.to_s.upcase,
+              description: ::Ci::Pipeline::STATUSES_DESCRIPTION[state_symbol],
+              value: state_symbol.to_s
       end
     end
   end

app/models/concerns/ci/has_status.rb

@@ -16,6 +16,19 @@ module Ci
     STATUSES_ENUM = { created: 0, pending: 1, running: 2, success: 3,
                       failed: 4, canceled: 5, skipped: 6, manual: 7,
                       scheduled: 8, preparing: 9, waiting_for_resource: 10 }.freeze
+    STATUSES_DESCRIPTION = {
+      created: 'Pipeline has been created',
+      waiting_for_resource: 'A resource (for example, a runner) that the pipeline requires to run is unavailable',
+      preparing: 'Pipeline is preparing to run',
+      pending: 'Pipeline has not started running yet',
+      running: 'Pipeline is running',
+      failed: 'At least one stage of the pipeline failed',
+      success: 'Pipeline completed successfully',
+      canceled: 'Pipeline was canceled before completion',
+      skipped: 'Pipeline was skipped',
+      manual: 'Pipeline needs to be manually started',
+      scheduled: 'Pipeline is scheduled to run'
+    }.freeze
 
     UnknownStatusError = Class.new(StandardError)
 

doc/api/graphql/reference/index.md

@@ -8021,17 +8021,17 @@ Rotation length unit of an on-call rotation.
 
 | Value | Description |
 | ----- | ----------- |
-| `CANCELED` |  |
-| `CREATED` |  |
-| `FAILED` |  |
-| `MANUAL` |  |
-| `PENDING` |  |
-| `PREPARING` |  |
-| `RUNNING` |  |
-| `SCHEDULED` |  |
-| `SKIPPED` |  |
-| `SUCCESS` |  |
-| `WAITING_FOR_RESOURCE` |  |
+| `CANCELED` | Pipeline was canceled before completion. |
+| `CREATED` | Pipeline has been created. |
+| `FAILED` | At least one stage of the pipeline failed. |
+| `MANUAL` | Pipeline needs to be manually started. |
+| `PENDING` | Pipeline has not started running yet. |
+| `PREPARING` | Pipeline is preparing to run. |
+| `RUNNING` | Pipeline is running. |
+| `SCHEDULED` | Pipeline is scheduled to run. |
+| `SKIPPED` | Pipeline was skipped. |
+| `SUCCESS` | Pipeline completed successfully. |
+| `WAITING_FOR_RESOURCE` | A resource (for example, a runner) that the pipeline requires to run is unavailable. |
 
 ### `ProjectMemberRelation`