Align description of ADO and GHA (#5202)

* Align description of ADO and GHA * Update description.go --------- Co-authored-by: Christopher Fenner <[email protected]>
SAP · Dec 9, 2024 · ec77db1 · ec77db1
1 parent a70422c
commit ec77db1
Showing 1 changed file with 3 additions and 2 deletions.
diff --git 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)