tools, build: run settings generator in CI
CI should fail if you update the package.json without updating the
corresponding documentation. Confirmed that this works in an earlier,
intentionally broken patchset.
Updates golang/vscode-go#198.
Change-Id: I375e17ea7981bd045145128ac398ef1aa4c3f33d
Reviewed-on: https://go-review.googlesource.com/c/vscode-go/+/237877
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
diff --git a/build/all.bash b/build/all.bash
index f658f90..10c3110 100755
--- a/build/all.bash
+++ b/build/all.bash
@@ -9,7 +9,7 @@
Usage: $0 [subcommand]
Available subcommands:
help - display this help message.
- test - build and test locally. Some tests may fail if vscode is alreay in use.
+ test - build and test locally. Some tests may fail if vscode is already in use.
testlocal - build and test in a locally built container.
ci - build and test with headless vscode. Requires Xvfb.
EOUSAGE
@@ -48,6 +48,9 @@
npm run unit-test
npm test --silent
npm run lint
+
+ echo "**** Run settings generator ****"
+ go run tools/generate.go -w=false
}
run_test_in_docker() {
diff --git a/tools/generate.go b/tools/generate.go
index 6dc6745..f93ce88 100644
--- a/tools/generate.go
+++ b/tools/generate.go
@@ -8,12 +8,18 @@
import (
"bytes"
"encoding/json"
+ "flag"
"fmt"
"io/ioutil"
"log"
"os"
"path/filepath"
"sort"
+ "strings"
+)
+
+var (
+ writeFlag = flag.Bool("w", true, "Write new file contents to disk.")
)
type PackageJSON struct {
@@ -40,14 +46,13 @@
}
func main() {
+ flag.Parse()
+
// Assume this is running from the vscode-go directory.
dir, err := os.Getwd()
if err != nil {
log.Fatal(err)
}
- if filepath.Base(dir) != "vscode-go" {
- log.Fatalf("run this script from the vscode-go root directory")
- }
// Find the package.json file.
data, err := ioutil.ReadFile(filepath.Join(dir, "package.json"))
if err != nil {
@@ -58,24 +63,39 @@
log.Fatal(err)
}
rewrite := func(filename string, toAdd []byte) {
- content, err := ioutil.ReadFile(filename)
+ oldContent, err := ioutil.ReadFile(filename)
if err != nil {
log.Fatal(err)
}
gen := []byte(`<!-- Everything below this line is generated. DO NOT EDIT. -->`)
- split := bytes.Split(content, gen)
+ split := bytes.Split(oldContent, gen)
if len(split) == 1 {
- log.Fatalf("expected to find %q in %s, not found", filename, gen)
+ log.Fatalf("expected to find %q in %s, not found", gen, filename)
}
s := bytes.Join([][]byte{
bytes.TrimSpace(split[0]),
gen,
toAdd,
}, []byte("\n\n"))
- if err := ioutil.WriteFile(filename, append(s, '\n'), 0644); err != nil {
- log.Fatal(err)
+ newContent := append(s, '\n')
+
+ // Return early if the contents are unchanged.
+ if bytes.Equal(oldContent, newContent) {
+ return
}
- fmt.Printf("regenerated %s\n", filename)
+
+ // Either write out new contents or report an error (if in CI).
+ if *writeFlag {
+ if err := ioutil.WriteFile(filename, newContent, 0644); err != nil {
+ log.Fatal(err)
+ }
+ fmt.Printf("updated %s\n", filename)
+ } else {
+ base := filepath.Join("docs", filepath.Base(filename))
+ fmt.Printf(`%s have changed in the package.json, but documentation in %s was not updated.
+`, strings.TrimSuffix(base, ".md"), base)
+ os.Exit(1)
+ }
}
var b bytes.Buffer
for i, c := range pkgJSON.Contributes.Commands {
