Skip to content

Configuration

Relicta reads relicta.config.yaml in your repo root by default. Example:

versioning:
strategy: conventional
tag_prefix: v
prerelease: false # e.g., rc, beta when true
build_metadata: "" # optional +build meta
git_tag: true
git_push: true
changelog:
file: CHANGELOG.md
format: keep-a-changelog
repository_url: https://github.com/your-org/your-repo
ai:
enabled: true
provider: openai
model: gpt-4
tone: professional
audience: developers
plugins:
- name: github
enabled: true
config:
draft: false
- name: slack
enabled: true
config:
webhook: ${SLACK_WEBHOOK_URL}
workflow:
require_approval: true
allowed_branches:
- main
  • versioning: strategy (conventional), tag_prefix, prerelease, build_metadata, git_tag, git_push.
  • changelog: file, format (e.g., keep-a-changelog), repository_url for links.
  • ai: enabled, provider (openai, anthropic, gemini, azure, ollama), model, tone, audience.
  • plugins: list of plugins with name, enabled, and config (see Plugins for each).
  • workflow: require_approval, allowed_branches, optional auto_publish or other org policies.
  • --config: path to the config file (defaults to relicta.config.yaml in repo root).
  • --dry-run: preview without changing the repo.
  • --json: emit machine-readable output.
  • --chdir: run as if started in another directory.
  • OPENAI_API_KEY, ANTHROPIC_API_KEY, GEMINI_API_KEY, AZURE_OPENAI_API_KEY, AZURE_OPENAI_ENDPOINT
  • OLLAMA_HOST (if using local Ollama)
  • GITHUB_TOKEN
  • Plugin credentials (see Plugins):
    • Slack: SLACK_WEBHOOK_URL
    • npm: NPM_TOKEN (if publishing)
    • LaunchNotes: LAUNCHNOTES_API_TOKEN
  • Commit relicta.config.yaml so CI and local runs are identical.
  • Use environment-variable substitution for secrets (e.g., ${SLACK_WEBHOOK_URL}) to keep config in git.
  • Pair --json with jq for automation and dashboards.