docs: clarify usage descriptions for webhook and build parameters

- Update usage descriptions for various webhook parameters to provide clearer context.
- Improve clarity in usage statements for Discord webhook configurations.
- Enhance descriptions for build-related parameters to better explain their purpose.
- Revise usage text for GitHub Actions parameters to ensure consistency and clarity.

Signed-off-by: appleboy <appleboy.tw@gmail.com>

main.go

@@ -38,201 +38,201 @@ func main() {
 	app.Flags = []cli.Flag{
 		&cli.StringFlag{
 			Name:    "webhook-url",
-			Usage:   "discord webhook url",
+			Usage:   "The Discord webhook URL to send messages to.",
 			EnvVars: []string{"PLUGIN_WEBHOOK_URL", "WEBHOOK_URL", "DISCORD_WEBHOOK_URL", "INPUT_WEBHOOK_URL"},
 		},
 		&cli.StringFlag{
 			Name:    "webhook-id",
-			Usage:   "discord webhook id",
+			Usage:   "The Discord webhook ID.",
 			EnvVars: []string{"PLUGIN_WEBHOOK_ID", "WEBHOOK_ID", "DISCORD_WEBHOOK_ID", "INPUT_WEBHOOK_ID"},
 		},
 		&cli.StringFlag{
 			Name:    "webhook-token",
-			Usage:   "discord webhook token",
+			Usage:   "The Discord webhook token.",
 			EnvVars: []string{"PLUGIN_WEBHOOK_TOKEN", "WEBHOOK_TOKEN", "DISCORD_WEBHOOK_TOKEN", "INPUT_WEBHOOK_TOKEN"},
 		},
 		&cli.StringSliceFlag{
 			Name:    "message",
-			Usage:   "the message contents (up to 2000 characters)",
+			Usage:   "The message contents to send to the Discord channel (up to 2000 characters).",
 			EnvVars: []string{"PLUGIN_MESSAGE", "DISCORD_MESSAGE", "MESSAGE", "INPUT_MESSAGE"},
 		},
 		&cli.StringSliceFlag{
 			Name:    "file",
-			Usage:   "the contents of the file being sent",
+			Usage:   "The contents of the file being sent to the Discord channel.",
 			EnvVars: []string{"PLUGIN_FILE", "DISCORD_FILE", "FILE", "INPUT_FILE"},
 		},
 		&cli.StringFlag{
 			Name:    "color",
-			Usage:   "color code of the embed",
+			Usage:   "The color code of the embed message.",
 			EnvVars: []string{"PLUGIN_COLOR", "COLOR", "INPUT_COLOR"},
 		},
 		&cli.BoolFlag{
 			Name:    "wait",
-			Usage:   "waits for server confirmation of message send before response, and returns the created message body",
+			Usage:   "Wait for server confirmation of message send before response, and return the created message body.",
 			EnvVars: []string{"PLUGIN_WAIT", "WAIT", "INPUT_WAIT"},
 		},
 		&cli.BoolFlag{
 			Name:    "tts",
-			Usage:   "true if this is a TTS message",
+			Usage:   "Set to true if this is a Text-to-Speech (TTS) message.",
 			EnvVars: []string{"PLUGIN_TTS", "TTS", "INPUT_TTS"},
 		},
 		&cli.StringFlag{
 			Name:    "username",
-			Usage:   "override the default username of the webhook",
+			Usage:   "Override the default username of the webhook.",
 			EnvVars: []string{"PLUGIN_USERNAME", "USERNAME", "INPUT_USERNAME"},
 		},
 		&cli.StringFlag{
 			Name:    "avatar-url",
-			Usage:   "override the default avatar of the webhook",
+			Usage:   "Override the default avatar of the webhook.",
 			EnvVars: []string{"PLUGIN_AVATAR_URL", "AVATAR_URL", "INPUT_AVATAR_URL"},
 		},
 		&cli.BoolFlag{
 			Name:    "drone",
-			Usage:   "environment is drone",
+			Usage:   "Indicate if the environment is Drone CI.",
 			EnvVars: []string{"DRONE"},
 		},
 		&cli.StringFlag{
 			Name:    "ci.environment",
-			Usage:   "ci environment name",
+			Usage:   "The name of the CI environment.",
 			EnvVars: []string{"CI"},
 		},
 		&cli.StringFlag{
 			Name:    "repo",
-			Usage:   "repository owner and repository name",
+			Usage:   "The repository owner and repository name.",
 			EnvVars: []string{"DRONE_REPO", "CI_REPO", "GITHUB_REPOSITORY"},
 		},
 		&cli.StringFlag{
 			Name:    "repo.namespace",
-			Usage:   "repository namespace",
+			Usage:   "The repository namespace.",
 			EnvVars: []string{"DRONE_REPO_OWNER", "DRONE_REPO_NAMESPACE", "CI_REPO_OWNER", "GITHUB_ACTOR"},
 		},
 		&cli.StringFlag{
 			Name:    "repo.name",
-			Usage:   "repository name",
+			Usage:   "The repository name.",
 			EnvVars: []string{"DRONE_REPO_NAME", "CI_REPO_NAME"},
 		},
 		&cli.StringFlag{
 			Name:    "commit.sha",
-			Usage:   "git commit sha",
+			Usage:   "The Git commit SHA.",
 			EnvVars: []string{"DRONE_COMMIT_SHA", "CI_COMMIT_SHA", "GITHUB_SHA"},
 		},
 		&cli.StringFlag{
 			Name:    "commit.ref",
-			Usage:   "git commit ref",
+			Usage:   "The Git commit reference.",
 			EnvVars: []string{"DRONE_COMMIT_REF", "CI_COMMIT_REF", "GITHUB_REF"},
 		},
 		&cli.StringFlag{
 			Name:    "commit.branch",
 			Value:   "master",
-			Usage:   "git commit branch",
+			Usage:   "The Git commit branch.",
 			EnvVars: []string{"DRONE_COMMIT_BRANCH", "CI_COMMIT_BRANCH"},
 		},
 		&cli.StringFlag{
 			Name:    "commit.link",
-			Usage:   "git commit link",
+			Usage:   "The link to the Git commit.",
 			EnvVars: []string{"DRONE_COMMIT_LINK", "CI_PIPELINE_FORGE_URL"},
 		},
 		&cli.StringFlag{
 			Name:    "commit.author",
-			Usage:   "git author name",
+			Usage:   "The name of the Git commit author.",
 			EnvVars: []string{"DRONE_COMMIT_AUTHOR", "CI_COMMIT_AUTHOR"},
 		},
 		&cli.StringFlag{
 			Name:    "commit.author.email",
-			Usage:   "git author email",
+			Usage:   "The email of the Git commit author.",
 			EnvVars: []string{"DRONE_COMMIT_AUTHOR_EMAIL", "CI_COMMIT_AUTHOR_EMAIL"},
 		},
 		&cli.StringFlag{
 			Name:    "commit.author.avatar",
-			Usage:   "git author avatar",
+			Usage:   "The avatar URL of the Git commit author.",
 			EnvVars: []string{"DRONE_COMMIT_AUTHOR_AVATAR", "CI_COMMIT_AUTHOR_AVATAR"},
 		},
 		&cli.StringFlag{
 			Name:    "commit.message",
-			Usage:   "commit message",
+			Usage:   "The Git commit message.",
 			EnvVars: []string{"DRONE_COMMIT_MESSAGE", "CI_COMMIT_MESSAGE"},
 		},
 		&cli.StringFlag{
 			Name:    "source.branch",
 			Value:   "develop",
-			Usage:   "git source branch",
+			Usage:   "The Git source branch.",
 			EnvVars: []string{"DRONE_SOURCE_BRANCH", "CI_COMMIT_SOURCE_BRANCH"},
 		},
 		&cli.StringFlag{
 			Name:    "build.event",
 			Value:   "push",
-			Usage:   "build event",
+			Usage:   "The build event type.",
 			EnvVars: []string{"DRONE_BUILD_EVENT", "CI_PIPELINE_EVENT"},
 		},
 		&cli.IntFlag{
 			Name:    "build.number",
-			Usage:   "build number",
+			Usage:   "The build number.",
 			EnvVars: []string{"DRONE_BUILD_NUMBER", "CI_PIPELINE_NUMBER"},
 		},
 		&cli.StringFlag{
 			Name:    "build.status",
-			Usage:   "build status",
+			Usage:   "The build status.",
 			Value:   "success",
 			EnvVars: []string{"DRONE_BUILD_STATUS", "CI_PIPELINE_STATUS"},
 		},
 		&cli.StringFlag{
 			Name:    "build.link",
-			Usage:   "build link",
+			Usage:   "The link to the build.",
 			EnvVars: []string{"DRONE_BUILD_LINK", "CI_PIPELINE_URL"},
 		},
 		&cli.StringFlag{
 			Name:    "build.tag",
-			Usage:   "build tag",
+			Usage:   "The build tag.",
 			EnvVars: []string{"DRONE_TAG", "CI_COMMIT_TAG"},
 		},
 		&cli.StringFlag{
 			Name:    "pull.request",
-			Usage:   "pull request",
+			Usage:   "The pull request number.",
 			EnvVars: []string{"DRONE_PULL_REQUEST", "CI_COMMIT_PULL_REQUEST"},
 		},
 		&cli.Int64Flag{
 			Name:    "build.started",
-			Usage:   "build started",
+			Usage:   "The timestamp when the build started.",
 			EnvVars: []string{"DRONE_BUILD_STARTED", "CI_PIPELINE_STARTED"},
 		},
 		&cli.Int64Flag{
 			Name:    "build.finished",
-			Usage:   "build finished",
+			Usage:   "The timestamp when the build finished.",
 			EnvVars: []string{"DRONE_BUILD_FINISHED", "CI_PIPELINE_FINISHED"},
 		},
 		&cli.BoolFlag{
 			Name:    "github",
-			Usage:   "Boolean value, indicates the runtime environment is GitHub Action.",
+			Usage:   "Indicate if the runtime environment is GitHub Actions.",
 			EnvVars: []string{"PLUGIN_GITHUB", "GITHUB"},
 		},
 		&cli.StringFlag{
 			Name:    "github.workflow",
-			Usage:   "The name of the workflow.",
+			Usage:   "The name of the GitHub Actions workflow.",
 			EnvVars: []string{"GITHUB_WORKFLOW"},
 		},
 		&cli.StringFlag{
 			Name:    "github.action",
-			Usage:   "The name of the action.",
+			Usage:   "The name of the GitHub Actions action.",
 			EnvVars: []string{"GITHUB_ACTION"},
 		},
 		&cli.StringFlag{
 			Name:    "github.event.name",
-			Usage:   "The webhook name of the event that triggered the workflow.",
+			Usage:   "The name of the GitHub event that triggered the workflow.",
 			EnvVars: []string{"GITHUB_EVENT_NAME"},
 		},
 		&cli.StringFlag{
 			Name:    "github.event.path",
-			Usage:   "The path to a file that contains the payload of the event that triggered the workflow. Value: /github/workflow/event.json.",
+			Usage:   "The path to the file containing the payload of the event that triggered the workflow. Default: /github/workflow/event.json",
 			EnvVars: []string{"GITHUB_EVENT_PATH"},
 		},
 		&cli.StringFlag{
 			Name:    "github.workspace",
-			Usage:   "The GitHub workspace path. Value: /github/workspace.",
+			Usage:   "The GitHub workspace path. Default: /github/workspace",
 			EnvVars: []string{"GITHUB_WORKSPACE"},
 		},
 		&cli.StringFlag{
 			Name:    "deploy.to",
-			Usage:   "Provides the target deployment environment for the running build. This value is only available to promotion and rollback pipelines.",
+			Usage:   "The target deployment environment for the running build. This value is only available to promotion and rollback pipelines.",
 			EnvVars: []string{"DRONE_DEPLOY_TO", "CI_PIPELINE_DEPLOY_TARGET"},
 		},
 	}