Add backticks around stack IDs for markdown summary

paketo-buildpacks · Nov 19, 2021 · 76c0567 · 76c0567
1 parent b773570
commit 76c0567
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 25 deletions.
diff --git a/internal/formatter.go b/internal/formatter.go
@@ -30,7 +30,7 @@ func printImplementation(writer io.Writer, config cargo.Config) {
 
 		fmt.Fprintf(writer, "#### Supported Stacks:\n")
 		for _, s := range config.Stacks {
-			fmt.Fprintf(writer, "- %s\n", s.ID)
+			fmt.Fprintf(writer, "- `%s`\n", s.ID)
 		}
 		fmt.Fprintln(writer)
 	}

diff --git a/internal/formatter_test.go b/internal/formatter_test.go
@@ -80,14 +80,11 @@ func testFormatter(t *testing.T, context spec.G, it spec.S) {
 
 				"\n\n**ID:** `some-buildpack`\n\n" +
 
-				"**Digest:** `sha256:some-buildpack-sha`" +
-
+				"**Digest:** `sha256:some-buildpack-sha`\n\n" +
+				"#### Supported Stacks:" +
+				"- `other-stack`\n" +
+				"- `some-stack`\n" +
 				`
-
-#### Supported Stacks:
-- other-stack
-- some-stack
-
 #### Default Dependency Versions:
 | ID | Version |
 |---|---|
@@ -126,15 +123,12 @@ func testFormatter(t *testing.T, context spec.G, it spec.S) {
 
 					"\n\n**ID:** `some-buildpack`\n\n" +
 
-					"**Digest:** `sha256:some-buildpack-sha`" +
-
-					`
-
-#### Supported Stacks:
-- other-stack
-- some-stack
+					"**Digest:** `sha256:some-buildpack-sha`\n\n" +
 
-`))
+					"#### Supported Stacks:\n" +
+					"- `other-stack`\n" +
+					"- `some-stack`\n\n",
+				))
 			})
 		})
 

diff --git a/summarize_test.go b/summarize_test.go
@@ -274,10 +274,10 @@ version = "3.4.5"
 
 				"\n\n**ID:** `some-buildpack`\n\n" +
 
-				`#### Supported Stacks:
-- other-stack
-- some-stack
-
+				"#### Supported Stacks:\n" +
+				"- `other-stack`\n" +
+				"- `some-stack`\n" +
+				`
 #### Default Dependency Versions:
 | ID | Version |
 |---|---|
@@ -298,11 +298,10 @@ version = "3.4.5"
 <summary>Other Buildpack 2.3.4</summary>` +
 
 				"\n\n**ID:** `other-buildpack`\n\n" +
-
-				`#### Supported Stacks:
-- first-stack
-- second-stack
-
+				"#### Supported Stacks:\n" +
+				"- `first-stack`\n" +
+				"- `second-stack`\n" +
+				`
 #### Default Dependency Versions:
 | ID | Version |
 |---|---|