Skip to content

Update README with itest notes#1580

Merged
jasperblues merged 1 commit intomainfrom
feature/itest-docs
Apr 6, 2026
Merged

Update README with itest notes#1580
jasperblues merged 1 commit intomainfrom
feature/itest-docs

Conversation

@jasperblues
Copy link
Copy Markdown
Contributor

Add integration test instructions to README

Motivation

The README documented mvn test for unit tests but had no guidance on running integration tests (*IT) that hit real provider APIs. This was raised during #1577 (IT test automation).

README vs Guide

Integration test instructions belong in the README (contributor-facing) rather than the user guide (user-facing — covers building agents with the framework, not contributing to it). If contributor documentation grows, a CONTRIBUTING.md would be the natural next step, or perhaps a section in the user guide that covers contributor concerns.

Changes

  • README.md — added "Integration tests" subsection under "Running Tests". Documents required environment variables (OPENAI_API_KEY, ANTHROPIC_API_KEY, DEEPSEEK_API_KEY, MISTRAL_API_KEY), the command to run all IT tests excluding Ollama, and how to scope to a specific module with -pl.

@jasperblues jasperblues requested a review from igordayen April 6, 2026 00:48
Copy link
Copy Markdown
Contributor

@igordayen igordayen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks very good.

@jasperblues jasperblues merged commit 5cb2ecf into main Apr 6, 2026
10 checks passed
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 6, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants