docs: tips for agents on running integration tests#5884
docs: tips for agents on running integration tests#5884theosanderson wants to merge 3 commits intomainfrom
Conversation
Added troubleshooting section for k3d setup and updated deployment instructions.
|
Claude finished @theosanderson's task in 1m 7s —— View job Code Review Complete ✓Todo List
SummaryThis PR significantly improves the integration test documentation by solving a critical networking issue with k3d local testing. The changes replace the problematic Strengths:
Minor improvements suggested (see inline comments):
Overall, this is a valuable addition that will help developers (and AI agents!) successfully run integration tests locally. The documentation quality is high and the technical approach is sound. |
| echo 'localHost: host.k3d.internal' > /tmp/k3d-values.yaml | ||
|
|
||
| # Deploy with Helm | ||
| SHA=$(git rev-parse HEAD | cut -c1-7) |
There was a problem hiding this comment.
The --sha flag is computed from the current HEAD, but the --branch main is hardcoded. This could be confusing when testing local changes on a different branch. Consider either:
- Making the branch dynamic:
--branch $(git branch --show-current) - Adding a comment explaining why main is always used here, even when on a feature branch
|
|
||
| # Add host entry so the browser can resolve host.k3d.internal | ||
| # (requires sudo - add this line to /etc/hosts) | ||
| echo '127.0.0.1 host.k3d.internal' | sudo tee -a /etc/hosts |
There was a problem hiding this comment.
Using tee -a (append mode) could result in duplicate entries if this command is run multiple times. Consider either:
- Using a one-liner that checks first:
grep -q 'host.k3d.internal' /etc/hosts || echo '127.0.0.1 host.k3d.internal' | sudo tee -a /etc/hosts - Adding a note to warn users about running this multiple times
- Updating the troubleshooting section to mention checking for duplicates
This is just used by my claude - it's the way it found to manage to get integration tests to work locally. With this addition it consistently manages to use the integration tests to test local changes (I'm running it on a linux box).
🚀 Preview: Add
previewlabel to enable