diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml new file mode 100644 index 0000000..bfe3f82 --- /dev/null +++ b/.github/workflows/tests.yml @@ -0,0 +1,32 @@ +name: tests +on: + pull_request: {} + push: + branches: + - main + - master + +jobs: + test: + name: test + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v4 + - name: make test + run: | + go install github.com/google/go-jsonnet/cmd/jsonnet@latest + go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest + make test + docs: + name: docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-go@v4 + - name: make docs + run: | + go install github.com/jsonnet-libs/docsonnet@master + make docs + git diff --exit-code + \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 0fbf376..fbd33a5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ permalink: / --- -# package xtd +# xtd ```jsonnet local xtd = import "github.com/jsonnet-libs/xtd/main.libsonnet" @@ -14,8 +14,6 @@ This package serves as a test field for functions intended to be contributed to in the future, but also provides a place for less general, yet useful utilities. -## Subpackages - * [aggregate](aggregate.md) * [array](array.md) * [ascii](ascii.md) diff --git a/docs/aggregate.md b/docs/aggregate.md index aba530d..a877ddf 100644 --- a/docs/aggregate.md +++ b/docs/aggregate.md @@ -2,7 +2,7 @@ permalink: /aggregate/ --- -# package aggregate +# aggregate ```jsonnet local aggregate = import "github.com/jsonnet-libs/xtd/aggregate.libsonnet" diff --git a/docs/array.md b/docs/array.md index 1d9e4a8..f273293 100644 --- a/docs/array.md +++ b/docs/array.md @@ -2,7 +2,7 @@ permalink: /array/ --- -# package array +# array ```jsonnet local array = import "github.com/jsonnet-libs/xtd/array.libsonnet" diff --git a/docs/ascii.md b/docs/ascii.md index 37d7ed7..9a85053 100644 --- a/docs/ascii.md +++ b/docs/ascii.md @@ -2,7 +2,7 @@ permalink: /ascii/ --- -# package ascii +# ascii ```jsonnet local ascii = import "github.com/jsonnet-libs/xtd/ascii.libsonnet" diff --git a/docs/camelcase.md b/docs/camelcase.md index 0634fa9..c33f7e8 100644 --- a/docs/camelcase.md +++ b/docs/camelcase.md @@ -2,7 +2,7 @@ permalink: /camelcase/ --- -# package camelcase +# camelcase ```jsonnet local camelcase = import "github.com/jsonnet-libs/xtd/camelcase.libsonnet" diff --git a/docs/date.md b/docs/date.md index e2c9295..f4a6f9d 100644 --- a/docs/date.md +++ b/docs/date.md @@ -2,7 +2,7 @@ permalink: /date/ --- -# package date +# date ```jsonnet local date = import "github.com/jsonnet-libs/xtd/date.libsonnet" diff --git a/docs/inspect.md b/docs/inspect.md index 726d330..94575ca 100644 --- a/docs/inspect.md +++ b/docs/inspect.md @@ -2,7 +2,7 @@ permalink: /inspect/ --- -# package inspect +# inspect ```jsonnet local inspect = import "github.com/jsonnet-libs/xtd/inspect.libsonnet" diff --git a/docs/jsonpath.md b/docs/jsonpath.md index 8b0e30d..94a4a4b 100644 --- a/docs/jsonpath.md +++ b/docs/jsonpath.md @@ -2,7 +2,7 @@ permalink: /jsonpath/ --- -# package jsonpath +# jsonpath ```jsonnet local jsonpath = import "github.com/jsonnet-libs/xtd/jsonpath.libsonnet" diff --git a/docs/string.md b/docs/string.md index 17b75b5..62873e5 100644 --- a/docs/string.md +++ b/docs/string.md @@ -2,7 +2,7 @@ permalink: /string/ --- -# package string +# string ```jsonnet local string = import "github.com/jsonnet-libs/xtd/string.libsonnet" diff --git a/docs/url.md b/docs/url.md index 728957d..db898bc 100644 --- a/docs/url.md +++ b/docs/url.md @@ -2,7 +2,7 @@ permalink: /url/ --- -# package url +# url ```jsonnet local url = import "github.com/jsonnet-libs/xtd/url.libsonnet"