Skip to main content

Configuration templates

This page describes a minimal, practical configuration setup for using Ogoron in a repository.

Files layout​

Ogoron stores configuration under:

.ogoron/configs/
  config.yml
  test_execution.yml

Initialize the directory and templates:

ogoron init

Validate after changes:

ogoron init validate

config.yml (minimal)​

config.yml is the main place where a repository declares where generated tests and helpers should live.

Example:

paths:
  tests: tests
  helpers: tests/support

test_codegen:
  test_file_template: "{name}_spec.rb"
  helpers_file_template: "helpers_{timestamp}.rb"

config.yml: common fields​

paths.tests is the most important field. It defines where generated tests are written and updated.

Optional fields:

  • paths.helpers — where generated shared helpers/support files are written
  • test_codegen.test_file_template — file naming template for generated test files
  • test_codegen.helpers_file_template — file naming template for generated helper files

OGORON_KEY​

Ogoron requires OGORON_KEY to run. It is provided during onboarding.

Recommended: store it in your CI secrets and export it locally.

Test execution and SUT presets​

For ogoron run tests and SUT presets, see:

In CI/CD, it is common to commit only a curated subset of outputs:

  • .ogoron/keep-git/** — repository-tracked Ogoron outputs
  • the tests directory from config.yml: paths.tests

This convention keeps .ogoron/for-human/** available for local review and debugging, while keeping commits focused.

Important: do not ignore keep-git​

Do not add .ogoron/keep-git/** to .gitignore.

Ignoring it typically degrades the quality of generation and maintenance workflows, especially across branches and pull requests.

Environment variables (minimal)​

Required:

  • OGORON_KEY

Optional (paths overrides):

  • OGORON_TESTS_PATH
  • OGORON_SUPPORT_PATH

Optional (output formatting):

  • OGORON_PLAIN (also enabled automatically when CI=true)
  • OGORON_NO_COLOR (also respects NO_COLOR)

Optional (networking):

  • HTTP_PROXY, HTTPS_PROXY, NO_PROXY (and lowercase variants)