@turbo/types 2.7.5-canary.2 → 2.7.5-canary.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turbo/types",
-  "version": "2.7.5-canary.2",
+  "version": "2.7.5-canary.4",
   "description": "Turborepo types",
   "type": "commonjs",
   "homepage": "https://turborepo.com",

package/schemas/schema.json

@@ -345,6 +345,17 @@
             }
           ]
         },
+        "description": {
+          "description": "A human-readable description of what this task does.\n\nThis field is for documentation purposes only and does not affect task execution or caching behavior.",
+          "anyOf": [
+            {
+              "$ref": "#/definitions/String"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
         "env": {
           "description": "A list of environment variables that this task depends on.\n\nNote: If you are migrating from a turbo version 1.5 or below, you may be used to prefixing your variables with a `$`. You no longer need to use the `$` prefix.\n\nDocumentation: https://turborepo.com/docs/reference/configuration#env",
           "type": ["array", "null"],

package/schemas/schema.v2.json

@@ -116,6 +116,10 @@
     "Pipeline": {
       "type": "object",
       "properties": {
+        "description": {
+          "type": "string",
+          "description": "A human-readable description of what this task does.\n\nThis field is for documentation purposes only and does not affect task execution or caching behavior."
+        },
         "dependsOn": {
           "type": "array",
           "items": {

package/src/types/config-v2.ts

@@ -199,6 +199,14 @@ export interface RootSchema extends BaseSchema {
 }
 
 export interface Pipeline {
+  /**
+   * A human-readable description of what this task does.
+   *
+   * This field is for documentation purposes only and does not affect
+   * task execution or caching behavior.
+   */
+  description?: string;
+
   /**
    * The list of tasks that this task depends on.
    *