fix code generation due to goldmark's changes to Node.Text

Close #458

Upstream context is yuin/goldmark#471

Author: rhysd

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/mattn/go-colorable v0.1.13
 	github.com/mattn/go-runewidth v0.0.16
 	github.com/robfig/cron/v3 v3.0.1
-	github.com/yuin/goldmark v1.7.4
+	github.com/yuin/goldmark v1.7.8
 	golang.org/x/sync v0.8.0
 	golang.org/x/sys v0.26.0
 	gopkg.in/yaml.v3 v3.0.1

go.sum

@@ -14,8 +14,8 @@ github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
 github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/robfig/cron/v3 v3.0.1 h1:WdRxkvbJztn8LMz/QEvLN5sBU+xKpSqwwUO1Pjr4qDs=
 github.com/robfig/cron/v3 v3.0.1/go.mod h1:eQICP3HwyT7UooqI/z+Ov+PtYAWygg1TEWWzGIFLtro=
-github.com/yuin/goldmark v1.7.4 h1:BDXOHExt+A7gwPCJgPIIq7ENvceR7we7rOS9TNoLZeg=
-github.com/yuin/goldmark v1.7.4/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
+github.com/yuin/goldmark v1.7.8 h1:iERMLn0/QJeHFhxSt3p6PeN9mGnvIKSpG9YYorDMnic=
+github.com/yuin/goldmark v1.7.8/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
 golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
 golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

scripts/generate-availability/main.go

@@ -26,6 +26,25 @@ const theURL = "https://raw.githubusercontent.com/github/docs/main/content/actio
 var dbg = log.New(io.Discard, "", log.LstdFlags)
 var reReplaceholder = regexp.MustCompile("{%[^%]+%}")
 
+// `ast.Walk` doesn't work for `TableCell`'s children.
+func buildTextOf(n ast.Node, src []byte, b *strings.Builder) {
+	for c := n.FirstChild(); c != nil; c = c.NextSibling() {
+		if t, ok := c.(*ast.Text); ok {
+			b.Write(t.Value(src))
+		} else {
+			buildTextOf(c, src, b)
+		}
+	}
+}
+
+// `Node.Text` method was deprecated. This is alternative to it.
+// https://github.com/yuin/goldmark/issues/471
+func textOf(n ast.Node, src []byte) string {
+	var b strings.Builder
+	buildTextOf(n, src, &b)
+	return b.String()
+}
+
 type switchCase struct {
 	ctx  []string
 	sp   []string
@@ -62,7 +81,7 @@ func parseContextAvailabilityTable(src []byte) (*extast.Table, bool) {
 	n := root.FirstChild()
 
 	for ; n != nil; n = n.NextSibling() {
-		if h, ok := n.(*ast.Heading); ok && h.Level == 3 && bytes.Equal(h.Text(src), []byte("Context availability")) {
+		if h, ok := n.(*ast.Heading); ok && h.Level == 3 && textOf(h, src) == "Context availability" {
 			n = n.NextSibling()
 			break
 		}
@@ -84,7 +103,7 @@ func cells(n *extast.TableRow, src []byte) []string {
 	t := []string{}
 	for c := n.FirstChild(); c != nil; c = c.NextSibling() {
 		if tc, ok := c.(*extast.TableCell); ok {
-			t = append(t, string(tc.Text(src)))
+			t = append(t, textOf(tc, src))
 		}
 	}
 	return t
@@ -162,7 +181,7 @@ func WorkflowKeyAvailability(key string) ([]string, []string) {
 
 		key := cs[0]
 		if key == "" {
-			dbg.Printf("Skip %q due to empty key\n", r.Text(src))
+			dbg.Printf("Skip %q due to empty key\n", textOf(r, src))
 			continue
 		}
 		ctx := split(cs[1])

scripts/generate-webhook-events/main.go

@@ -22,19 +22,36 @@ const theURL = "https://raw.githubusercontent.com/github/docs/main/content/actio
 
 var dbg = log.New(io.Discard, "", log.LstdFlags)
 
-func getFirstLinkText(n ast.Node, src []byte) (string, bool) {
-	var link ast.Node
+// `Node.Text` method was deprecated. This is alternative to it.
+// https://github.com/yuin/goldmark/issues/471
+func textOf(n ast.Node, src []byte) string {
+	var b strings.Builder
+
 	ast.Walk(n, func(n ast.Node, entering bool) (ast.WalkStatus, error) {
 		if !entering {
 			return ast.WalkStop, nil
 		}
+		if t, ok := n.(*ast.Text); ok {
+			b.Write(t.Value(src))
+		}
+		return ast.WalkContinue, nil
+	})
+
+	return b.String()
+}
 
-		if n.Kind() != ast.KindLink {
-			return ast.WalkContinue, nil
+func getFirstLinkText(n ast.Node, src []byte) (string, bool) {
+	var link *ast.Link
+	ast.Walk(n, func(n ast.Node, entering bool) (ast.WalkStatus, error) {
+		if !entering {
+			return ast.WalkStop, nil
 		}
 
-		link = n // Found
-		return ast.WalkStop, nil
+		if l, ok := n.(*ast.Link); ok {
+			link = l
+			return ast.WalkStop, nil
+		}
+		return ast.WalkContinue, nil
 	})
 
 	if link == nil {
@@ -43,28 +60,23 @@ func getFirstLinkText(n ast.Node, src []byte) (string, bool) {
 
 	// Note: All text pieces must be collected. For example the text "pull_request" is pieces of
 	// "pull_" and "request" since an underscore is delimiter of italic/bold text.
-	var b strings.Builder
-	for c := link.FirstChild(); c != nil; c = c.NextSibling() {
-		b.Write(c.Text(src))
-	}
-
-	return b.String(), true
+	return textOf(link, src), true
 }
 
 func collectCodeSpans(n ast.Node, src []byte) []string {
 	spans := []string{}
 	ast.Walk(n, func(n ast.Node, entering bool) (ast.WalkStatus, error) {
 		kind := n.Kind()
 		if entering && kind == ast.KindCodeSpan {
-			spans = append(spans, string(n.Text(src)))
+			spans = append(spans, textOf(n, src))
 		}
 		return ast.WalkContinue, nil
 	})
 	return spans
 }
 
 func getWebhookTypes(table ast.Node, src []byte) ([]string, bool, error) {
-	dbg.Printf("Table: %s", table.Text(src))
+	dbg.Println("Table:", textOf(table, src))
 
 	sawHeader := false
 	for c := table.FirstChild(); c != nil; c = c.NextSibling() {
@@ -74,7 +86,7 @@ func getWebhookTypes(table ast.Node, src []byte) ([]string, bool, error) {
 			sawHeader = true
 
 			cell := c.FirstChild()
-			if string(cell.Text(src)) != "Webhook event payload" {
+			if textOf(cell, src) != "Webhook event payload" {
 				dbg.Println("  Skip this table because it is not for Webhook event payload")
 				return nil, false, nil
 			}
@@ -95,7 +107,7 @@ func getWebhookTypes(table ast.Node, src []byte) ([]string, bool, error) {
 			cell := c.FirstChild()
 			name, ok := getFirstLinkText(cell, src)
 			if !ok {
-				return nil, false, fmt.Errorf("\"Webhook event payload\" table was found, but first cell did not contain hook name: %q", cell.Text(src))
+				return nil, false, fmt.Errorf("\"Webhook event payload\" table was found, but first cell did not contain hook name: %q", textOf(cell, src))
 			}
 
 			// Second cell
@@ -138,15 +150,15 @@ Toplevel:
 		k := n.Kind()
 		if !sawAbout {
 			// When '## About events that trigger workflows'
-			if h, ok := n.(*ast.Heading); ok && h.Level == 2 && string(h.Text(src)) == "About events that trigger workflows" {
+			if h, ok := n.(*ast.Heading); ok && h.Level == 2 && textOf(h, src) == "About events that trigger workflows" {
 				sawAbout = true
 				dbg.Println("Found \"About events that trigger workflows\" heading")
 			}
 			continue
 		}
 
 		if h, ok := n.(*ast.Heading); ok && h.Level == 2 {
-			currentHook = string(h.Text(src))
+			currentHook = textOf(h, src)
 			dbg.Printf("Found new hook %q\n", currentHook)
 			continue
 		}