Contributing

Building locally

dev1 is an example of a tag to test locally.

./build-lgtm.sh dev1 will build the docker image locally.
./run-lgtm.sh dev1 will run the docker image locally.

Linting

Markdown lint: markdownlint -f -i container -i examples/python/venv . (-f fixes simple violations, requires markdownlint)
Markdown link checker: lychee . (requires lychee)
Run all checks: ./scripts/lint.sh

Acceptance Tests

Acceptance test cases are defined in oats.yaml files in the examples directory. The test cases are run by oats.

If a test case fails (lets say "examples/jdbc/spring-boot-reactive-2"), follows these steps:

Check out the oats repository
Go to the oats folder
cd yaml
Install ginkgo: go install github.com/onsi/ginkgo/v2/ginkgo
TESTCASE_TIMEOUT=2h TESTCASE_BASE_PATH=/path/to/this/repo/examples ginkgo -v -r (or the sub-directory you're debugging)
go to http://localhost:3000