V1 api

.github/scripts/modtidy-check.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+TMPDIR="$(mktemp -d)"
+trap 'rm -rf -- "$TMPDIR"' EXIT
+
+# Copy files before 'go mod tidy' potentially modifies them.
+cp go.{mod,sum} "${TMPDIR}"
+
+go mod tidy
+
+diff go.mod "${TMPDIR}/go.mod"
+diff go.sum "${TMPDIR}/go.sum"
+
+if ! git diff --no-index --quiet go.mod "${TMPDIR}/go.mod"; then
+    echo -ne "\n\nRunning 'go mod tidy' modified go.mod"
+    exit 1
+fi
+if ! git diff --no-index --quiet go.sum "${TMPDIR}/go.sum"; then
+    echo -ne "\n\nRunning 'go mod tidy' modified go.sum"
+    exit 1
+fi

.github/workflows/coverage.yml

@@ -7,7 +7,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.19.x
+          go-version: 1.21.x
       - run: go test -coverprofile=coverage.txt
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3

.github/workflows/tests-linux.yml

@@ -4,22 +4,14 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.17.x, 1.18.x, 1.19.x]
+        go-version: [1.20.x, 1.21.x]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go-version }}
+      - name: go mod tidy check
+        run: .github/scripts/modtidy-check.sh
       - name: Tests
-        run: go test -race ./...
-
-  test-examples:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v3
-        with:
-          go-version: 1.19.x
-      - name: Test Examples
-        run: cd _example && go test -race .
+        run: go test -race -shuffle=on ./...

.github/workflows/tests-others.yml

@@ -10,6 +10,6 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-go@v3
         with:
-          go-version: 1.19.x
+          go-version: 1.21.x
       - name: Tests
-        run: go test -race ./...
+        run: go test -race -shuffle=on ./...

CHANGELOG.md

@@ -1,3 +1,7 @@
+Unreleased
+==============
+  * Add light/dark mode selector (#108)
+
 v0.5.2 / 2023-03-29
 ==============
   * Ensure all files have a correct Content-Type (#106)

CONTRIBUTING.md

@@ -1,14 +1,14 @@
 Contributing
 ============
 
-First of all, thank you for considering to contribute to statsviz!
+First of all, thank you for considering to contribute to Statsviz!
 
 Pull-requests are welcome!
 
 
 ## Go library
 
-The statsviz Go public API is relatively light so there's not much to do and at the moment
+The Statsviz Go public API is relatively light so there's not much to do and at the moment
 it's unlikely that the API will change. However some new options can be added to
 `statsviz.Register` without breaking compatibility.
 
@@ -29,6 +29,12 @@ The user interface aims to be simple, light and minimal.
 Assets are located in the `internal/static` directory and are embedded with
 [`go:embed`](https://pkg.go.dev/embed).
 
+Depending on what your modifications are, it's always a good idea to check that
+some of the examples in [./_example](./_example/) work with your modifications
+to Statsviz. To do so `cd` to the directory of the example and run:
+
+    go mod edit -replace=github.com/arl/statsviz=../../
+
 
 ## Documentation
 
@@ -38,21 +44,22 @@ are welcome!
 
 ## Examples
 
-There are many Go libraries to handle HTTP routing.
+There are many Go libraries to handle HTTP requests, routing, etc..
 
-Feel free to add an example to show how to register statsviz with your favourite
+Feel free to add an example to show how to register Statsviz with your favourite
 library.
 
-Please add a directory under `./_example`. For instance, if you want to add an
-example showing how to register statsviz within library `foobar`:
+To do so, please add a directory under `./_example`. For instance, if you want to add an
+example showing how to register Statsviz within library `foobar`:
 
  - create a directory `./_example/foobar/`
  - create a file `./_example/foobar/main.go`
  - call `go example.Work()` as the first line of your example (see other
    examples). This forces the garbage collector to _do something_ so that
-   statsviz interface won't remain static when an user runs your example.
+   Statsviz interface won't remain static when an user runs your example.
  - the code should be `gofmt`ed
  - the example should compile and run
- - when ran, statsviz interface should be accessible at http://localhost:8080/debug/statsviz
+ - when ran, Statsviz interface should be accessible at http://localhost:8080/debug/statsviz
+
 
 Thank you!