how to release

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+## Acceptance Tests
+
+Acceptance test cases are defined in `oats.yaml` files in the examples directory. The test cases are run by [oats].
+The declarative yaml tests are described in <https://github.com/grafana/oats/blob/main/yaml>.
+
+If a test case fails (lets say "examples/jdbc/spring-boot-reactive-2"), follows these steps:
+
+1. Check out the [oats] repo
+2. Go to the oats folder
+3. `cd yaml`
+4. Install ginkgo: `go install github.com/onsi/ginkgo/v2/ginkgo`
+5. `TESTCASE_TIMEOUT=2h TESTCASE_BASE_PATH=/path/to/this/repo/examples ginkgo -v -r -focus 'jdbc-spring-boot-reactive-2'`
+6. go to <http://localhost:3000> and login with admin/admin
+
+Use `-focus 'yaml'` to run all acceptance tests.
+
+[oats]: https://github.com/grafana/oats

RELEASING.md

@@ -0,0 +1,14 @@
+# Releasing
+
+## Publish Release via Github Workflow
+
+### Create a Release
+
+1. switch to the `main` branch.
+2. Create and push a version.
+
+```sh
+git checkout main
+git tag -a v<VERSION> -m "Release v<VERSION>"
+git push origin v<VERSION>
+```