diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..fb79946 --- /dev/null +++ b/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 . + +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 and login with admin/admin + +Use `-focus 'yaml'` to run all acceptance tests. + +[oats]: https://github.com/grafana/oats diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..de7b5d6 --- /dev/null +++ b/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 -m "Release v" +git push origin v +```