From ec77db1aa865ad7eaa69cd5c2027c141473caa80 Mon Sep 17 00:00:00 2001 From: Ashly Mathew Date: Mon, 9 Dec 2024 10:36:58 +0100 Subject: [PATCH] Align description of ADO and GHA (#5202) * Align description of ADO and GHA * Update description.go --------- Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com> --- pkg/documentation/generator/description.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pkg/documentation/generator/description.go b/pkg/documentation/generator/description.go index 8e9e65cdc..744a15d1b 100644 --- a/pkg/documentation/generator/description.go +++ b/pkg/documentation/generator/description.go @@ -65,6 +65,7 @@ func createDescriptionSection(stepData *config.StepData) string { description += fmt.Sprintf("%v name: %v\n", spacingTabBox, stepData.Metadata.Name) description += fmt.Sprintf("%v inputs:\n", spacingTabBox) description += fmt.Sprintf("%v stepName: %v\n", spacingTabBox, stepData.Metadata.Name) + description += fmt.Sprintf("%v flags: --anyStepParameter\n", spacingTabBox) description += fmt.Sprintf("%v```\n\n", spacingTabBox) } @@ -73,8 +74,8 @@ func createDescriptionSection(stepData *config.StepData) string { description += headlineGHA description += fmt.Sprintf("%v```\n", spacingTabBox) description += fmt.Sprintf("%vsteps:\n", spacingTabBox) - description += fmt.Sprintf("%v - name: your preferred name for the step\n", spacingTabBox) - description += fmt.Sprintf("%v uses: SAP/project-piper-action@main\n", spacingTabBox) + description += fmt.Sprintf("%v - uses: SAP/project-piper-action@releaseCommitSHA\n", spacingTabBox) + description += fmt.Sprintf("%v name: %v\n", spacingTabBox, stepData.Metadata.Name) description += fmt.Sprintf("%v with:\n", spacingTabBox) description += fmt.Sprintf("%v step-name: %v\n", spacingTabBox, stepData.Metadata.Name) description += fmt.Sprintf("%v flags: --anyStepParameter\n", spacingTabBox)