Update step.yaml (#532)

Author: NimRegev

graduated/codefresh-run/step.yaml

@@ -59,54 +59,54 @@ spec:
             },
             "PIPELINE_ID": {
                 "type": "string",
-                "description": "Pipeline name or id"
+                "description": "Name or ID of pipeline to run. In the UI, select Pipelines. Click pipeline name, then select Settings, and get the Name and ID."
             },
             "TRIGGER_ID": {
                 "type": "string",
-                "description": "Trigger id or name",
+                "description": "Name or ID of trigger for specified pipeline. Mandatory when BRANCH or SHA are defined. In the UI, select Pipelines. Click pipeline name, then select Workflows > Triggers. Click Edit and get the Name. ",
                 "default": ""
             },
             "BRANCH": {
                 "type": "string",
-                "description": "Branch",
+                "description": "Branch for which to run the pipeline. When defined, TRIGGER_ID must also be defined.",
                 "examples": ["master"],
                 "default": ""
             },
             "SHA": {
                 "type": "string",
-                "description": "Set commit sha",
+                "description": "Git commit hash. When defined, TRIGGER_ID must also be defined.",
                 "examples": ["c777d850ff67969cb4eb9e041d7edeb367705e12"],
                 "default": ""
             },
             "NO_CACHE": {
                 "type": "boolean",
-                "description": "Ignore cached images",
+                "description": "Ignore cached images.",
                 "default": false
             },
             "NO_CF_CACHE": {
                    "type": "boolean",
-                   "description": "Ignore Codefresh cache optimizations",
+                   "description": "Ignore Codefresh cache optimizations.",
                    "default": false
                },
             "ENABLE_NOTIFICATIONS": {
                 "type": "boolean",
-                "description": "Report notifications about pipeline execution",
+                "description": "Send email notifications on pipeline build status.",
                 "default": false
             },
             "RESET_VOLUME": {
                   "type": "boolean",
-                  "description": "Reset pipeline cached volume",
+                  "description": "Reset pipeline cached volume.",
                   "default": false
             },
             "RUNTIME_NAME": {
                 "type": "string",
-                "description": "Runtime environment to run the pipeline",
+                "description": "Runtime environment to run the pipeline.",
                 "examples": ["my-runtime-name"],
                 "default": ""
             },
             "DETACH": {
                  "type": "boolean",
-                 "description": "Run pipeline and print build ID",
+                 "description": "Run pipeline without assigning to a project and print build ID.",
                  "default": false
              },
             "FOLLOW_LOGS": {
@@ -119,7 +119,7 @@ spec:
                  "items": {
                      "type": "string"
                  },
-                 "description": "Run pipeline with contexts",
+                 "description": "Run pipeline with execution contexts.",
                  "examples": ["git-context-1"],
                  "default": []
              },
@@ -128,19 +128,19 @@ spec:
                  "items": {
                      "type": "string"
                  },
-                 "description": "Set build variables",
+                 "description": "Set build variables.",
                  "examples": ["key=val"],
                  "default": []
              },
             "VARIABLE_FILE": {
                   "type": "string",
-                  "description": "Set build variables from a file",
+                  "description": "Import build variables from a file.",
                   "examples": ["/codefresh/volume/my-repo/var_file_example.yml"],
                   "default": ""
             },             
             "TIMEOUT_MINS": {
                 "type": "string",
-                "description": "Timeout in mins",
+                "description": "Timeout in minutes after which to consider pipeline build as failed.",
                 "examples": ["33.3", "45"],
                 "default": "45"
             },
@@ -149,7 +149,7 @@ spec:
                   "items": {
                       "type": "string"
                   },
-                  "description": "run only specifc steps",
+                  "description": "Run only specifc steps defined.",
                   "examples": ["step1", "step2"],
                   "default": []
               },
@@ -158,7 +158,7 @@ spec:
                   "items": {
                       "type": "string"
                   },
-                  "description": "skip specifc steps",
+                  "description": "Skip the specifc steps defined.",
                   "examples": ["step1", "step2"],
                   "default": []
               }