From a4a13e1d6f3756eb043fd6766d866871712d5ce2 Mon Sep 17 00:00:00 2001 From: Xiyu-z Date: Sat, 10 Oct 2026 11:00:16 +0800 Subject: [PATCH] docs: clarify description key is optional for composite actions Mark description field as optional for composite actions and add recommendation note. --- .../actions/reference/workflows-and-actions/metadata-syntax.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/actions/reference/workflows-and-actions/metadata-syntax.md b/content/actions/reference/workflows-and-actions/metadata-syntax.md index 8d9aca01ffea..039281306919 100644 --- a/content/actions/reference/workflows-and-actions/metadata-syntax.md +++ b/content/actions/reference/workflows-and-actions/metadata-syntax.md @@ -33,7 +33,8 @@ category: ## `description` -**Required** A short description of the action. +**Optional** A short description of the action. While optional, it is highly recommended to include a description. + ## `inputs`