feat: 各插件文档增加云原生构建内容，增加tag (#47)

Co-authored-by: folgerfan <folgerfan@tencent.com>
coding · Mar 22, 2024 · 197d77c · 197d77c
1 parent 97a4362
commit 197d77c
Show file tree

Hide file tree

Showing 77 changed files with 152 additions and 128 deletions.
diff --git a/plugins/ansible/ansible/README.md b/plugins/ansible/ansible/README.md
@@ -14,10 +14,10 @@ docker run --rm \
   plugins/ansible
 ```
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: use ansible
@@ -79,7 +79,7 @@ ssh-keygen -t ed25519 -f ./ssh-key
 即：`plugins/ansible:3`，示例如下
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: use ansible
@@ -95,7 +95,7 @@ master:
 可通过 imports 动态注入凭证，达到隐藏明文凭证的目标
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: use ansible
@@ -108,7 +108,7 @@ master:
 ```
 
 ```yml
-#ssh-key.yml
+# ssh-key.yml
 PRIVATE_KEY: |
   xxxxxx
   xxxxxx

diff --git a/plugins/ansible/ansible/plugin-meta.json b/plugins/ansible/ansible/plugin-meta.json
@@ -1,7 +1,7 @@
 {
   "name": "Ansible",
   "description": "Ansible can help you demonstrate value, connect teams, and deliver efficiencies for your organization. ",
-  "tags": ["publish", "rsync"],
+  "tags": ["publish", "rsync", "transfer", "ssh"],
   "mark": "社区",
   "images": "https://hub.docker.com/r/plugins/ansible/tags",
   "source": "https://github.com/drone-plugins/drone-ansible",

diff --git a/plugins/artifactory/artifactory/README.md b/plugins/artifactory/artifactory/README.md
@@ -2,10 +2,10 @@
 
 发布文件或者制品到制品库。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: artifactory

diff --git a/plugins/artifactory/artifactory/plugin-meta.json b/plugins/artifactory/artifactory/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "Artifactory",
   "description": "发布文件或者制品到制品库插件",
   "mark": "社区",
-  "tags": [ "publish"],
+  "tags": [ "publish", "archive"],
   "images": "https://hub.docker.com/r/lathieriot/drone-artifactory",
   "source": "https://github.com/athieriot/drone-artifactory",
   "bugs": "https://github.com/athieriot/drone-artifactory/issues",

diff --git a/plugins/clair/clair/README.md b/plugins/clair/clair/README.md
@@ -2,10 +2,10 @@
 
 通过 Clair 扫描 docker 镜像插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: clair
@@ -44,7 +44,7 @@ master:
 
 * password：Docker Registry密码，用于下载 `scan_image`。
 
-* scan_image：要扫描的 docker 图像。支持 Docker Hub 或私有仓库。
+* scan_image：要扫描的 docker 镜像。支持 Docker Hub 或私有仓库。
 
 * ca_cert：用于验证 https 的 CA 证书。
 

diff --git a/plugins/clair/clair/plugin-meta.json b/plugins/clair/clair/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "Clair",
   "description": "通过Clair扫描docker镜像",
   "mark": "社区",
-  "tags": [ "DOCKER"],
+  "tags": [ "docker", "scan", "clair"],
   "images": "https://hub.docker.com/r/jmccann/drone-clair",
   "source": "https://github.com/jmccann/drone-clair",
   "bugs": "https://github.com/jmccann/drone-clair/issues",

diff --git a/plugins/codecov/codecov/README.md b/plugins/codecov/codecov/README.md
@@ -2,10 +2,10 @@
 
 推送测试报告到Codecov
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: codecov

diff --git a/plugins/codecov/codecov/plugin-meta.json b/plugins/codecov/codecov/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "Codecov",
   "description": "推送测试报告到Codecov",
   "mark": "社区",
-  "tags": [ "test","publish"],
+  "tags": [ "test","publish", "report", "codecov" ],
   "images": "https://hub.docker.com/r/robertstettner/drone-codecov",
   "source": "https://github.com/robertstettner/drone-codecov",
   "bugs": "https://github.com/robertstettner/drone-codecov/issues",

diff --git a/plugins/datadog/datadog/README.md b/plugins/datadog/datadog/README.md
@@ -2,10 +2,10 @@
 
 发送 events 和 metrics 到 Datadog
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: count-pipeline

diff --git a/plugins/datadog/datadog/plugin-meta.json b/plugins/datadog/datadog/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "Datadog",
   "description": "发送events和metrics到Datadog",
   "mark": "社区",
-  "tags": [ "monitoring"],
+  "tags": [ "monitoring", "metrics", "events", "report"],
   "images": "https://hub.docker.com/r/masci/drone-datadog",
   "source": "https://github.com/masci/drone-datadog",
   "bugs": "https://github.com/masci/drone-datadog/issues",

diff --git a/plugins/diagnostics/diagnostics/README.md b/plugins/diagnostics/diagnostics/README.md
@@ -2,7 +2,7 @@
 
 一个 cli 工具插件，用于诊断构建过程中出现的问题。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 插件内置了一些诊断工具，可以用命令行来调用它们。
 
@@ -13,7 +13,7 @@
 - dig
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: run plugins/drone-diagnostics plugin

diff --git a/plugins/diagnostics/diagnostics/plugin-meta.json b/plugins/diagnostics/diagnostics/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "diagnostics",
   "description": "用来诊断构建中问题的带cli工具的插件",
   "mark": "社区",
-  "tags": [],
+  "tags": ["cli", "tools"],
   "images": "https://hub.docker.com/r/drone-plugins/drone-diagnostics",
   "source": "https://github.com/drone-plugins/drone-diagnostics",
   "bugs": "https://github.com/drone-plugins/drone-diagnostics/issues",

diff --git a/plugins/download/download/README.md b/plugins/download/download/README.md
@@ -2,10 +2,10 @@
 
 下载构建所需文件的插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: download  

diff --git a/plugins/download/download/plugin-meta.json b/plugins/download/download/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "download",
   "description": "下载构建所需文件的插件",
   "mark": "社区",
-  "tags": [ "tarball","archive","retrieve"],
+  "tags": ["tarball", "archive", "retrieve", "download"],
   "images": "https://hub.docker.com/r/drone-plugins/drone-download",
   "source": "https://github.com/drone-plugins/drone-download",
   "bugs": "https://github.com/drone-plugins/drone-download/issues",

diff --git a/plugins/email/email/README.md b/plugins/email/email/README.md
@@ -1,11 +1,11 @@
 # email
 
-通过email发送构建消息的插件。
+通过 email 发送构建消息的插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: notify

diff --git a/plugins/email/email/plugin-meta.json b/plugins/email/email/plugin-meta.json
@@ -1,8 +1,8 @@
 {
   "name": "email",
-  "description": "通过emial发送构建消息的插件",
+  "description": "通过email发送构建消息的插件",
   "mark": "社区",
-  "tags": [],
+  "tags": ["email", "notify", "message"],
   "images": "https://hub.docker.com/r/drillster/drone-email",
   "source": "https://github.com/drillster/drone-email",
   "bugs": "https://github.com/drillster/drone-email/issues",

diff --git a/plugins/ftps/ftps/README.md b/plugins/ftps/ftps/README.md
@@ -2,10 +2,10 @@
 
 通过 ftps 上传制品的插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: deploy

diff --git a/plugins/ftps/ftps/plugin-meta.json b/plugins/ftps/ftps/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "ftps",
   "description": "通过ftps上传制品的插件",
   "mark": "社区",
-  "tags": ["publish","ssh"],
+  "tags": ["publish", "ssh", "ftps", "archive"],
   "images": "https://hub.docker.com/r/cschlosser/drone-ftps",
   "source": "https://github.com/cschlosser/drone-ftps",
   "bugs": "https://github.com/cschlosser/drone-ftps/issues",

diff --git a/plugins/gpgsign/gpgsign/README.md b/plugins/gpgsign/gpgsign/README.md
@@ -2,10 +2,10 @@
 
 通过 GunPG 给制品加密的插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: sign  

diff --git a/plugins/gpgsign/gpgsign/plugin-meta.json b/plugins/gpgsign/gpgsign/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "gpgsign",
   "description": "通过GunPG给制品加密的插件",
   "mark": "社区",
-  "tags": [],
+  "tags": ["gunpg", "encrypt", "sign", "archive"],
   "images": "https://hub.docker.com/r/drone-plugins/drone-gpgsign",
   "source": "https://github.com/drone-plugins/drone-gpgsign",
   "bugs": "https://github.com/drone-plugins/drone-gpgsign/issues",

diff --git a/plugins/grafana-annotation/grafana-annotation/README.md b/plugins/grafana-annotation/grafana-annotation/README.md
@@ -2,10 +2,10 @@
 
 在 Grafana 中创建注解的插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: annotate

diff --git a/plugins/grafana-annotation/grafana-annotation/plugin-meta.json b/plugins/grafana-annotation/grafana-annotation/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "grafana-annotation",
   "description": "在Grafana中创建注解的插件",
   "mark": "社区",
-  "tags": [],
+  "tags": ["annotation", "grafana"],
   "images": "https://hub.docker.com/r/fdeschenes/drone-grafana-annotation",
   "source": "https://github.com/fdeschenes/drone-grafana-annotation",
   "bugs": "https://github.com/fdeschenes/drone-grafana-annotation/issues",

diff --git a/plugins/helm/helm/README.md b/plugins/helm/helm/README.md
@@ -2,10 +2,10 @@
 
 部署 Helm chart 的插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: helm_deploy

diff --git a/plugins/helm/helm/plugin-meta.json b/plugins/helm/helm/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "helm",
   "description": "Helm插件",
   "mark": "社区",
-  "tags": [],
+  "tags": ["helm", "deploy", "kubernetes", "k8s"],
   "images": "https://hub.docker.com/r/ipedrazas/drone-helm",
   "source": "https://github.com/ipedrazas/drone-helm",
   "bugs": "https://github.com/ipedrazas/drone-helm/issues",

diff --git a/plugins/helm3/helm3/README.md b/plugins/helm3/helm3/README.md
@@ -2,10 +2,10 @@
 
 Helm3 插件
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: deploy_production

diff --git a/plugins/helm3/helm3/plugin-meta.json b/plugins/helm3/helm3/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "helm3",
   "description": "Helm3插件",
   "mark": "社区",
-  "tags": [],
+  "tags": ["helm", "helm3", "kubernetes", "deploy"],
   "images": "https://hub.docker.com/r/pelotech/drone-helm3",
   "source": "https://github.com/pelotech/drone-helm3",
   "bugs": "https://github.com/pelotech/drone-helm3/issues",

diff --git a/plugins/hugo/hugo/README.md b/plugins/hugo/hugo/README.md
@@ -2,10 +2,10 @@
 
 通过 Hugo 自动创建静态 web 页面的插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: build

diff --git a/plugins/hugo/hugo/plugin-meta.json b/plugins/hugo/hugo/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "hugo",
   "description": "通过Hugo自动创建静态web页面的插件",
   "mark": "社区",
-  "tags": [],
+  "tags": ["hugo", "static", "website"],
   "images": "https://hub.docker.com/r/drone-plugins/drone-hugo",
   "source": "https://github.com/drone-plugins/drone-hugo",
   "bugs": "https://github.com/drone-plugins/drone-hugo/issues",

diff --git a/plugins/jenkins/jenkins/README.md b/plugins/jenkins/jenkins/README.md
@@ -2,10 +2,10 @@
 
 触发 Jenkins Jobs 的插件。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
   - stages:
     - name: trigger jenkins job

diff --git a/plugins/jenkins/jenkins/plugin-meta.json b/plugins/jenkins/jenkins/plugin-meta.json
@@ -2,7 +2,7 @@
   "name": "jenkins",
   "description": "触发Jenkins Jobs的插件",
   "mark": "社区",
-  "tags": [],
+  "tags": ["jenkins", "ci", "trigger"],
   "images": "https://hub.docker.com/r/appleboy/drone-jenkins",
   "source": "https://github.com/appleboy/drone-jenkins",
   "bugs": "https://github.com/appleboy/drone-jenkins/issues",

diff --git a/plugins/k8s/kubectl/README.md b/plugins/k8s/kubectl/README.md
@@ -4,10 +4,10 @@ Kubectl 是 Kubernetes 命令行接口。通过 Kubectl 命令可以方便的管
 
 Kubectl 同样可以管理腾讯云 tke 集群。
 
-## 在 Coding-CI 上使用
+## 在 云原生构建 上使用
 
 ```yml
-master:
+main:
   push:
     - stages:
       - name: 使用 kubectl 操作腾讯 TKE 更新指定pod的镜像版本
@@ -62,4 +62,3 @@ KUBECF: |
 - [kubectl文档](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands)
 - [bitnami/kubectl文档](https://github.com/bitnami/containers/tree/main/bitnami/kubectl)
 - [entrypoint](https://yeasy.gitbook.io/docker_practice/image/dockerfile/entrypoint)
-- [导入环境变量](https://ci.coding.net/docs/env.html#dao-ru-huan-jing-bian-liang)