fix actions description to be more clear

Signed-off-by: hlts2 <[email protected]>

.github/actions/deploy-chaos-mesh/action.yaml

@@ -1,5 +1,5 @@
 name: "Deploy Chaos Mesh"
-description: "Deploy Chaos Mesh"
+description: "A action to deploy Chaos Mesh"
 
 inputs:
   chaos_mesh_version:

.github/actions/detect-docker-image-tags/action.yaml

@@ -14,26 +14,26 @@
 # limitations under the License.
 #
 name: "Detect Docker image tags"
-description: "Detect Docker image tags"
+description: "A action to detect Docker image tags"
 
 inputs:
   tag_name:
-    description: "tag name to check whether exists or not"
+    description: "Tag name to check whether exists or not"
     required: true
     default: ""
   images:
-    description: "image names"
+    description: "Image names"
     required: false
     default: "vdaas/vald-agent-ngt \
       vdaas/vald-discoverer-k8s \
       vdaas/vald-lb-gateway \
       vdaas/vald-manager-index"
 outputs:
   HELM_EXTRA_OPTIONS:
-    description: "helm extra options that specifies image tags"
+    description: "Helm extra options that specifies image tags"
     value: ${{ steps.specify_container_versions.outputs.HELM_EXTRA_OPTIONS }}
   IMAGE_TAGS:
-    description: "specifies image tags"
+    description: "Specifies image tags"
     value: ${{ steps.specify_container_versions.outputs.IMAGE_TAGS }}
 
 runs:

.github/actions/determine-docker-image-tag/action.yaml

@@ -1,9 +1,9 @@
 name: "Determine Docker image tag"
-description: "Determine Docker image tag"
+description: "A action to determine Docker image tag"
 
 outputs:
   PRIMARY_TAG:
-    description: "primary tag"
+    description: "Primary tag"
     value: ${{ steps.determine_tag_name.outputs.PRIMARY_TAG }}
 
 runs:

.github/actions/docker-build/action.yaml

@@ -14,36 +14,36 @@
 # limitations under the License.
 #
 name: "Build Docker images"
-description: "Build Docker images and publish them"
+description: "A action to build Docker images and publish them"
 
 inputs:
   target:
-    description: "build target"
+    description: "Build target"
     required: true
     default: "base"
   builder:
-    description: "buildx builder name"
+    description: "Buildx builder name"
     required: true
     default: ""
   platforms:
-    description: "if it is specified, specified platforms will be used."
+    description: "If it is specified, specified platforms will be used."
     required: false
     default: ""
 outputs:
   IMAGE_NAME:
-    description: "image name"
+    description: "Image name"
     value: ${{ steps.image_name.outputs.IMAGE_NAME }}
   ALTER_IMAGE_NAME:
-    description: "alter image name"
+    description: "Alter image name"
     value: ${{ steps.image_name.outputs.ALTER_IMAGE_NAME }}
   PRIMARY_TAG:
-    description: "primary tag"
+    description: "Primary tag"
     value: ${{ steps.determine_tag_name.outputs.PRIMARY_TAG }}
   PLATFORMS:
-    description: "target platforms"
+    description: "Target platforms"
     value: ${{ steps.determine_platforms.outputs.PLATFORMS }}
   EXTRA_TAGS:
-    description: "extra tags"
+    description: "Extra tags"
     value: ${{ steps.add_extra_tags.outputs.EXTRA_TAGS }}
 
 runs:

.github/actions/e2e-deploy-vald-helm-operator/action.yaml

@@ -13,28 +13,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-name: "Setting E2E test environment"
-description: "A workflow to set E2E test environment"
+name: "Deploy Vald using vald-helm-operator for E2E test"
+description: "A action to deploy vald using vald-helm-operator for E2E test"
 
 inputs:
   require_minio:
     description: "If Minio is required, set this to true."
     required: false
     default: "false"
   helm_extra_options:
-    description: "extra options that passed to Helm command to deploy vald helm operator"
+    description: "Extra options that passed to Helm command to deploy vald helm operator"
     required: false
     default: ""
   valdrelease:
-    description: "path to the valdrelease.yaml that apply to cluster"
+    description: "Path to the valdrelease.yaml that apply to cluster"
     required: true
     default: "true"
   wait_for_selector:
-    description: "label selector used for specifying a pod waited for"
+    description: "Label selector used for specifying a pod waited for"
     required: false
     default: "app=vald-lb-gateway"
   wait_for_timeout:
-    description: "timeout used for waiting for pods"
+    description: "Timeout used for waiting for pods"
     required: false
     default: "600s"
   use_local_charts:
@@ -43,7 +43,7 @@ inputs:
     default: "true"
 outputs:
   POD_NAME:
-    description: "a pod name that waited for"
+    description: "A pod name that waited for"
     value: ${{ steps.deploy_vald.outputs.POD_NAME }}
 
 runs:
@@ -56,7 +56,7 @@ runs:
       run: |
         make K8S_SLEEP_DURATION_FOR_WAIT_COMMAND=10 k8s/external/minio/deploy
 
-    - name: Output valdrelease
+    - name: Dump valdrelease
       shell: bash
       run: |
         cat ${{ inputs.valdrelease }}

.github/actions/e2e-deploy-vald/action.yaml

@@ -13,28 +13,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-name: "Setting E2E test environment"
-description: "A workflow to set E2E test environment"
+name: "Deploy Vald for E2E test"
+description: "A action to deploy vald for E2E test"
 
 inputs:
   require_minio:
     description: "If Minio is required, set this to true."
     required: false
     default: "false"
   helm_extra_options:
-    description: "extra options that passed to Helm command."
+    description: "Extra options that passed to Helm command."
     required: false
     default: ""
   values:
-    description: "path to the values.yaml that passed to Helm command."
+    description: "Path to the values.yaml that passed to Helm command."
     required: false
     default: "false"
   wait_for_selector:
-    description: "label selector used for specifying a pod waited for"
+    description: "Label selector used for specifying a pod waited for"
     required: false
     default: "app=vald-lb-gateway"
   wait_for_timeout:
-    description: "timeout used for waiting for pods"
+    description: "Timeout used for waiting for pods"
     required: false
     default: "600s"
   use_local_charts:
@@ -43,7 +43,7 @@ inputs:
     default: "true"
 outputs:
   POD_NAME:
-    description: "a pod name that waited for"
+    description: "A pod name that waited for"
     value: ${{ steps.get_real_pod_name.outputs.POD_NAME }}
 
 runs:
@@ -56,7 +56,7 @@ runs:
       run: |
         make K8S_SLEEP_DURATION_FOR_WAIT_COMMAND=10 k8s/external/minio/deploy
 
-    - name: Output values
+    - name: Dump Helm values
       shell: bash
       run: |
         cat ${{ inputs.values }}

.github/actions/notify-slack/action.yaml

@@ -1,5 +1,5 @@
 name: "Notify Slack"
-description: "Notify Slack"
+description: "A action to notify Slack"
 
 inputs:
   author_name:
@@ -13,7 +13,7 @@ inputs:
     description: "Slack Notify Webhook URL"
     required: true
   status:
-    description: "Specify success or failure or cancelled or custom."
+    description: "Specify success or failure or cancelled or custom"
     required: false
 
 runs:

.github/actions/scan-docker-image/action.yaml

@@ -1,13 +1,13 @@
 name: "Scan the Docker image"
-description: "Scan the Docker image"
+description: "A action to scan the Docker image"
 
 inputs:
   image_ref:
     description: "Docker image reference"
     required: true
     default: ""
   severity:
-    description: "severities of vulnerabilities to be displayed"
+    description: "Severities of vulnerabilities to be displayed"
     required: false
     default: "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL"
 

.github/actions/setup-e2e/action.yaml

@@ -1,5 +1,5 @@
 name: "Setup E2E environment"
-description: "Setup the environment to run E2E test"
+description: "A action to set up the environment for executing E2E test"
 
 inputs:
   require_libhdf5:
@@ -19,11 +19,11 @@ inputs:
     required: false
     default: "true"
   ingress_port:
-    description: 'if it is not "0", ingress will be exposed to the specified port'
+    description: 'If it is not "0", ingress will be exposed to the specified port'
     required: false
     default: "0"
   target_images:
-    description: "image names"
+    description: "Image names"
     required: false
     default: "vdaas/vald-agent-ngt \
       vdaas/vald-discoverer-k8s \
@@ -32,10 +32,10 @@ inputs:
 
 outputs:
   HELM_EXTRA_OPTIONS:
-    description: "helm extra options that specifies E2E target image tags"
+    description: "Helm extra options that specifies E2E target image tags"
     value: ${{ steps.specify_container_versions.outputs.HELM_EXTRA_OPTIONS }}
   IMAGE_TAGS:
-    description: "specifies E2E target image tags"
+    description: "Specifies E2E target image tags"
     value: ${{ steps.specify_container_versions.outputs.IMAGE_TAGS }}
 
 runs:

.github/actions/setup-go/action.yaml

@@ -1,5 +1,5 @@
 name: "Setup Go environment"
-description: "Setup Go environment"
+description: "A action to set up Go environment"
 
 inputs:
   go_version:

.github/actions/setup-helm/action.yaml

@@ -1,5 +1,5 @@
 name: "Setup Helm environment"
-description: "Setup Helm environment"
+description: "A action to set up Helm environment"
 
 inputs:
   helm_version:

.github/actions/setup-k3d/action.yaml

@@ -1,25 +1,25 @@
 name: "Setup k3d environment"
-description: "GitHub Action for setting up k3d (k3s in Docker). It's lighter than KinD (Kubernetes in Docker)"
+description: "A action to set up k3d (k3s in Docker)"
 
 inputs:
   version:
     description: "k3d version"
     required: false
     default: "latest"
   name:
-    description: "cluster name"
+    description: "Cluster name"
     required: false
     default: "vald"
   ingress_port:
-    description: 'if it is not "0", ingress will be exposed to the specified port'
+    description: 'If it is not "0", ingress will be exposed to the specified port'
     required: false
     default: "0"
   agents:
-    description: "number of agents"
+    description: "Number of agents"
     required: false
     default: "3"
   options:
-    description: "options for k3d cluster create command"
+    description: "Options for k3d cluster create command"
     required: false
     default: ""
 

.github/actions/setup-yq/action.yaml

@@ -1,5 +1,5 @@
 name: "Setup yq environment"
-description: "GitHub Action for setting up yq"
+description: "A action to set up yq"
 
 inputs:
   yq_version:

.github/actions/wait-for-docker-image/action.yaml

@@ -14,7 +14,8 @@
 # limitations under the License.
 #
 name: "Wait for Docker Images"
-description: "Wait for Docker images to be published"
+description: "A action to wait for Docker images to be published"
+
 inputs:
   images:
     description: "image names"
@@ -24,6 +25,7 @@ inputs:
       vdaas/vald-lb-gateway \
       vdaas/vald-manager-index"
 outputs: {}
+
 runs:
   using: "composite"
   steps: