docs: update secrets allow_substitution API + CLI reference (#403)

go-vela · Mar 13, 2024 · 8d454cd · 8d454cd
1 parent 1416689
commit 8d454cd
Show file tree

Hide file tree

Showing 11 changed files with 374 additions and 29 deletions.
diff --git a/content/reference/api/admin/secret.md b/content/reference/api/admin/secret.md
@@ -47,6 +47,31 @@ existing entry for the secret.
   "images": ["alpine"],
   "events": ["push", "tag"],
   "allow_command": true,
+  "allow_substitution": true,
+  "allow_events": {
+    "push": {
+      "branch": true,
+      "tag": true,
+      "delete_branch": false,
+      "delete_tag": false
+    },
+    "pull_request": {
+      "opened": false,
+      "edited": false,
+      "synchronize": false,
+      "reopened": false
+    },
+    "deployment": {
+      "created": true
+    },
+    "comment": {
+      "created": false,
+      "edited": false
+    },
+    "schedule": {
+      "run": false
+    }
+  },
   "created_at": 1641314085,
   "created_by": "octokitty",
   "updated_at": 1641314500,
@@ -79,6 +104,31 @@ curl \
   "images": ["alpine"],
   "events": ["push", "tag"],
   "allow_command": true,
+  "allow_substitution": true,
+  "allow_events": {
+    "push": {
+      "branch": true,
+      "tag": true,
+      "delete_branch": false,
+      "delete_tag": false
+    },
+    "pull_request": {
+      "opened": false,
+      "edited": false,
+      "synchronize": false,
+      "reopened": false
+    },
+    "deployment": {
+      "created": true
+    },
+    "comment": {
+      "created": false,
+      "edited": false
+    },
+    "schedule": {
+      "run": false
+    }
+  },
   "created_at": 1641314085,
   "created_by": "octokitty",
   "updated_at": 1641314500,

diff --git a/content/reference/api/repo/add.md b/content/reference/api/repo/add.md
@@ -76,6 +76,30 @@ curl \
   "allow_deploy": false,
   "allow_tag": false,
   "allow_comment": false,
+  "allow_events": {
+    "push": {
+      "branch": true,
+      "tag": true,
+      "delete_branch": false,
+      "delete_tag": false
+    },
+    "pull_request": {
+      "opened": false,
+      "edited": false,
+      "synchronize": false,
+      "reopened": false
+    },
+    "deployment": {
+      "created": true
+    },
+    "comment": {
+      "created": false,
+      "edited": false
+    },
+    "schedule": {
+      "run": false
+    }
+  },
   "pipeline_type": "yaml"
 }
 ```
diff --git a/content/reference/api/repo/get.md b/content/reference/api/repo/get.md
@@ -74,6 +74,30 @@ curl \
     "allow_deploy": false,
     "allow_tag": false,
     "allow_comment": false,
+    "allow_events": {
+      "push": {
+        "branch": true,
+        "tag": true,
+        "delete_branch": false,
+        "delete_tag": false
+      },
+      "pull_request": {
+        "opened": false,
+        "edited": false,
+        "synchronize": false,
+        "reopened": false
+      },
+      "deployment": {
+        "created": true
+      },
+      "comment": {
+        "created": false,
+        "edited": false
+      },
+      "schedule": {
+        "run": false
+      }
+    },
     "pipeline_type": "yaml"
   },
   {
@@ -97,6 +121,30 @@ curl \
     "allow_deploy": false,
     "allow_tag": false,
     "allow_comment": false,
+    "allow_events": {
+      "push": {
+        "branch": true,
+        "tag": true,
+        "delete_branch": false,
+        "delete_tag": false
+      },
+      "pull_request": {
+        "opened": false,
+        "edited": false,
+        "synchronize": false,
+        "reopened": false
+      },
+      "deployment": {
+        "created": true
+      },
+      "comment": {
+        "created": false,
+        "edited": false
+      },
+      "schedule": {
+        "run": false
+      }
+    },
     "pipeline_type": "yaml"
   }
 ]
@@ -180,6 +228,30 @@ curl \
     "allow_deploy": false,
     "allow_tag": false,
     "allow_comment": false,
+    "allow_events": {
+      "push": {
+        "branch": true,
+        "tag": true,
+        "delete_branch": false,
+        "delete_tag": false
+      },
+      "pull_request": {
+        "opened": false,
+        "edited": false,
+        "synchronize": false,
+        "reopened": false
+      },
+      "deployment": {
+        "created": true
+      },
+      "comment": {
+        "created": false,
+        "edited": false
+      },
+      "schedule": {
+        "run": false
+      }
+    },
     "pipeline_type": "yaml"
   },
   {
@@ -203,6 +275,30 @@ curl \
     "allow_deploy": false,
     "allow_tag": false,
     "allow_comment": false,
+    "allow_events": {
+      "push": {
+        "branch": true,
+        "tag": true,
+        "delete_branch": false,
+        "delete_tag": false
+      },
+      "pull_request": {
+        "opened": false,
+        "edited": false,
+        "synchronize": false,
+        "reopened": false
+      },
+      "deployment": {
+        "created": true
+      },
+      "comment": {
+        "created": false,
+        "edited": false
+      },
+      "schedule": {
+        "run": false
+      }
+    },
     "pipeline_type": "yaml"
   }
 ]

diff --git a/content/reference/api/repo/update.md b/content/reference/api/repo/update.md
@@ -82,6 +82,30 @@ curl \
   "allow_deploy": false,
   "allow_tag": true,
   "allow_comment": false,
+  "allow_events": {
+    "push": {
+      "branch": true,
+      "tag": true,
+      "delete_branch": false,
+      "delete_tag": false
+    },
+    "pull_request": {
+      "opened": false,
+      "edited": false,
+      "synchronize": false,
+      "reopened": false
+    },
+    "deployment": {
+      "created": true
+    },
+    "comment": {
+      "created": false,
+      "edited": false
+    },
+    "schedule": {
+      "run": false
+    }
+  },
   "pipeline_type": "yaml"
 }
 ```
diff --git a/content/reference/api/repo/view.md b/content/reference/api/repo/view.md
@@ -72,6 +72,30 @@ curl \
   "allow_deploy": false,
   "allow_tag": false,
   "allow_comment": false,
+  "allow_events": {
+    "push": {
+      "branch": true,
+      "tag": true,
+      "delete_branch": false,
+      "delete_tag": false
+    },
+    "pull_request": {
+      "opened": false,
+      "edited": false,
+      "synchronize": false,
+      "reopened": false
+    },
+    "deployment": {
+      "created": true
+    },
+    "comment": {
+      "created": false,
+      "edited": false
+    },
+    "schedule": {
+      "run": false
+    }
+  },
   "pipeline_type": "yaml"
 }
 ```
diff --git a/content/reference/api/secret/add.md b/content/reference/api/secret/add.md
@@ -77,6 +77,31 @@ curl \
   "images": ["alpine"],
   "events": ["push"],
   "allow_command": true,
+  "allow_substitution": true,
+  "allow_events": {
+    "push": {
+      "branch": true,
+      "tag": true,
+      "delete_branch": false,
+      "delete_tag": false
+    },
+    "pull_request": {
+      "opened": false,
+      "edited": false,
+      "synchronize": false,
+      "reopened": false
+    },
+    "deployment": {
+      "created": true
+    },
+    "comment": {
+      "created": false,
+      "edited": false
+    },
+    "schedule": {
+      "run": false
+    }
+  },
   "created_at": 1641314085,
   "created_by": "octokitty",
   "updated_at": 1641314085,

diff --git a/content/reference/api/secret/get.md b/content/reference/api/secret/get.md
@@ -65,6 +65,31 @@ curl \
     "images": ["alpine"],
     "events": ["push"],
     "allow_command": true,
+    "allow_substitution": true,
+    "allow_events": {
+      "push": {
+        "branch": true,
+        "tag": true,
+        "delete_branch": false,
+        "delete_tag": false
+      },
+      "pull_request": {
+        "opened": false,
+        "edited": false,
+        "synchronize": false,
+        "reopened": false
+      },
+      "deployment": {
+        "created": true
+      },
+      "comment": {
+        "created": false,
+        "edited": false
+      },
+      "schedule": {
+        "run": false
+      }
+    },
     "created_at": 1641314085,
     "created_by": "octokitty",
     "updated_at": 1641314085,
@@ -81,6 +106,31 @@ curl \
     "images": ["alpine"],
     "events": ["push"],
     "allow_command": true,
+    "allow_substitution": true,
+    "allow_events": {
+      "push": {
+        "branch": true,
+        "tag": true,
+        "delete_branch": false,
+        "delete_tag": false
+      },
+      "pull_request": {
+        "opened": false,
+        "edited": false,
+        "synchronize": false,
+        "reopened": false
+      },
+      "deployment": {
+        "created": true
+      },
+      "comment": {
+        "created": false,
+        "edited": false
+      },
+      "schedule": {
+        "run": false
+      }
+    },
     "created_at": 1641314500,
     "created_by": "octokitty",
     "updated_at": 1641314500,