Revert "add support for Windows to update-checks-doc script"

This reverts commit 6807526.

because some outputs cannot be updated on Windows. For example the file
path separator is different on Windows. It is not useful to partially
support Windows by this tool.

Author: rhysd

.gitattributes

@@ -3,4 +3,3 @@
 /scripts/generate-webhook-events/testdata/** -text
 /scripts/generate-availability/testdata/** -text
 /scripts/generate-actionlint-matcher/test/** -text
-/scripts/update-checks-doc/testdata/** -text

.github/workflows/ci.yaml

@@ -104,6 +104,8 @@ jobs:
             echo "$diffs" >&2
             exit 1
           fi
+      - name: Check `docs/checks.md` is up-to-date
+        run: go run ./scripts/update-checks-doc -check ./docs/checks.md
       - name: Install staticcheck
         run: |
           go install honnef.co/go/tools/cmd/staticcheck@latest

Makefile

@@ -23,10 +23,9 @@ all: build test lint
 
 t test: .testtimestamp
 
-.staticchecktimestamp: $(TESTS) $(SRCS) $(TOOL) docs/checks.md
+.staticchecktimestamp: $(TESTS) $(SRCS) $(TOOL)
 	staticcheck ./...
 	GOOS=js GOARCH=wasm staticcheck ./playground
-	go run ./scripts/update-checks-doc -check -quiet docs/checks.md
 	touch .staticchecktimestamp
 
 l lint: .staticchecktimestamp

docs/checks.md

@@ -2182,7 +2182,6 @@ jobs:
 ```
 
 Output:
-<!-- Skip update output on Windows -->
 
 ```
 test.yaml:6:5: when a reusable workflow is called with "uses", "runs-on" is not available. only following keys are allowed: "name", "uses", "with", "secrets", "needs", "if", and "permissions" in job "job1" [syntax-check]

scripts/update-checks-doc/README.md

@@ -9,9 +9,12 @@ This script does:
 - update the links to the [playground](https://rhysd.github.io/actionlint/) for the example inputs
 - check the document is up-to-date
 
+For making the implementation simple, this script does not support Windows.
+
 ## Prerequisites
 
 - Go
+- Linux or macOS
 - `shellcheck` command
 - `pyflakes` command
 

scripts/update-checks-doc/main.go

@@ -11,7 +11,6 @@ import (
 	"io"
 	"log"
 	"os"
-	"runtime"
 	"strings"
 
 	"github.com/google/go-cmp/cmp"
@@ -184,7 +183,6 @@ func (u *Updater) Update() {
 	isInputHeader := l == "Example input:"
 	isOutputHeader := l == "Output:"
 	isSkipOutput := l == "<!-- Skip update output -->"
-	isSkipOutputWin := l == "<!-- Skip update output on Windows -->"
 	isSkipPlaygroundLink := l == "<!-- Skip playground link -->"
 	isPlaygroundLink := strings.HasPrefix(l, "[Playground](") && strings.HasSuffix(l, ")")
 
@@ -196,7 +194,7 @@ func (u *Updater) Update() {
 		u.expect(stateHeading, stateEnd)
 	case isOutputHeader:
 		u.expect(stateAfterInput)
-	case isSkipOutput, isSkipOutputWin:
+	case isSkipOutput:
 		u.expect(stateOutputHeader)
 	case isSkipPlaygroundLink, isPlaygroundLink:
 		u.expect(stateAfterOutput)
@@ -276,12 +274,8 @@ func (u *Updater) Update() {
 			u.state(stateOutputHeader, "Found example output header")
 		}
 	case stateOutputHeader:
-		if isSkipOutput || isSkipOutputWin && runtime.GOOS == "windows" {
-			reason := "Skip updating output due to the comment"
-			if isSkipOutputWin {
-				reason += " only on Windows"
-			}
-			u.state(stateAfterOutput, reason)
+		if isSkipOutput {
+			u.state(stateAfterOutput, "Skip updating output due to the comment")
 		} else if l == "```" {
 			u.state(stateOutputBlock, "Start code block for output")
 		}
@@ -323,10 +317,8 @@ var stderr io.Writer = os.Stderr
 
 func Main(args []string) error {
 	var check bool
-	var quiet bool
 	flags := flag.NewFlagSet(args[0], flag.ContinueOnError)
 	flags.BoolVar(&check, "check", false, "check the document is up-to-date")
-	flags.BoolVar(&quiet, "quiet", false, "disable trace log")
 	flags.SetOutput(stderr)
 	flags.Usage = func() {
 		fmt.Fprintln(stderr, "Usage: update-checks-doc [FLAGS] FILE\n\nFlags:")
@@ -343,20 +335,12 @@ func Main(args []string) error {
 	}
 	path := flags.Arg(0)
 
-	if quiet {
-		log.SetOutput(io.Discard)
-	}
-
 	in, err := os.ReadFile(path)
 	if err != nil {
 		return fmt.Errorf("could not read the document file: %w", err)
 	}
 	log.Printf("Read %d bytes from %q", len(in), path)
 
-	if runtime.GOOS == "windows" {
-		in = bytes.ReplaceAll(in, []byte{'\r', '\n'}, []byte{'\n'})
-	}
-
 	out, err := Update(in)
 	if err != nil {
 		return err

scripts/update-checks-doc/main_test.go

@@ -40,6 +40,9 @@ func testErr(t *testing.T, err error, want ...string) {
 }
 
 func TestMainGenerateOK(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("update-checks-doc doesn't support Windows")
+	}
 	root := t.TempDir()
 
 	in := must(os.Open(filepath.FromSlash("testdata/ok/minimal.in")))
@@ -61,15 +64,11 @@ func TestMainGenerateOK(t *testing.T) {
 }
 
 func TestMainCheckOK(t *testing.T) {
-	path := filepath.FromSlash("testdata/ok/minimal.out")
-	if err := Main([]string{"exe", "-check", path}); err != nil {
-		t.Fatal(err)
+	if runtime.GOOS == "windows" {
+		t.Skip("update-checks-doc doesn't support Windows")
 	}
-}
-
-func TestMainCheckQuietOK(t *testing.T) {
 	path := filepath.FromSlash("testdata/ok/minimal.out")
-	if err := Main([]string{"exe", "-check", "-quiet", path}); err != nil {
+	if err := Main([]string{"exe", "-check", path}); err != nil {
 		t.Fatal(err)
 	}
 }
@@ -81,6 +80,9 @@ func TestMainPrintHelp(t *testing.T) {
 }
 
 func TestMainCheckError(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("update-checks-doc doesn't support Windows")
+	}
 	path := filepath.FromSlash("testdata/ok/minimal.in")
 	testErr(t, Main([]string{"exe", "-check", path}), "checks document has some update")
 }
@@ -98,6 +100,9 @@ func TestMainInvalidCheckFlag(t *testing.T) {
 }
 
 func TestMainNoUpdate(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("update-checks-doc doesn't support Windows")
+	}
 	path := filepath.FromSlash("testdata/ok/minimal.out")
 	if err := Main([]string{"exe", path}); err != nil {
 		t.Fatal(err)
@@ -112,6 +117,10 @@ func TestMainUpdateError(t *testing.T) {
 }
 
 func TestUpdateOK(t *testing.T) {
+	if runtime.GOOS == "windows" {
+		t.Skip("update-checks-doc doesn't support Windows")
+	}
+
 	dir := filepath.FromSlash("testdata/ok")
 
 	tests := []string{}
@@ -120,18 +129,7 @@ func TestUpdateOK(t *testing.T) {
 		if !strings.HasSuffix(n, ".in") {
 			continue
 		}
-
-		id := strings.TrimSuffix(n, filepath.Ext(n))
-		// This test case does not work on Windows
-		if runtime.GOOS == "windows" && id == "replace_absolute_path" {
-			continue
-		}
-		// This test case only works on Windows
-		if runtime.GOOS != "windows" && id == "skip_output_on_windows" {
-			continue
-		}
-
-		tests = append(tests, id)
+		tests = append(tests, strings.TrimSuffix(n, filepath.Ext(n)))
 	}
 
 	for _, tc := range tests {