Skip to content

docs: record GRA-370 installer smoke evidence#259

Merged
Gradata merged 1 commit into
mainfrom
gra-370-smoke-artifact
Jun 5, 2026
Merged

docs: record GRA-370 installer smoke evidence#259
Gradata merged 1 commit into
mainfrom
gra-370-smoke-artifact

Conversation

@Gradata

@Gradata Gradata commented Jun 5, 2026

Copy link
Copy Markdown
Owner

Paperclip issue: GRA-370

Adds a durable smoke-report artifact for the installer telemetry/hook registration run.

Verification:

env -u BRAIN_DIR -u GRADATA_BRAIN /home/olive/.local/bin/uv run pytest \
  tests/test_install_smoke_matrix.py \
  tests/test_cli_install_agent.py \
  tests/test_hook_adapters.py \
  -q

Result:

34 passed, 2 skipped in 2.88s

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough
  • Added new smoke-test documentation for GRA-370 covering SDK installer and hook registration verification
  • Specifies relevant host targets: Codex, Hermes, and Cursor install-matrix behavior
  • Documents exact uv run pytest verification commands to execute from repository root
  • Records expected test outcomes: 34 passed, 2 skipped in 2.88s
  • Documents environment-contamination failure mode involving BRAIN_DIR and GRADATA_BRAIN variables
  • Notes best practices for keeping smoke runs isolated
  • Documentation-only change with no impact to public API or breaking changes

Walkthrough

This PR adds documentation for the GRA-370 installer telemetry and hook registration smoke tests, including verification commands, expected test outcomes, identified environment-contamination failure modes, and host-specific observation notes.

Changes

GRA-370 Smoke Test Documentation

Layer / File(s) Summary
GRA-370 installer and hook registration smoke test documentation
Gradata/docs/research/gra-370-installer-telemetry-smoke.md
Smoke test guide documents the SDK installer and hook registration verification path for GRA-370, specifying host targets (Codex, Hermes, Cursor install-matrix), uv run pytest verification commands to execute from Gradata/, expected pass/skip outcomes, environment-contamination failure modes involving BRAIN_DIR/GRADATA_BRAIN, and per-host evidence with isolation guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

docs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: record GRA-370 installer smoke evidence' accurately summarizes the main change—adding documentation that records smoke test evidence for the GRA-370 installer telemetry feature.
Description check ✅ Passed The description directly relates to the changeset, referencing GRA-370, explaining the purpose of the smoke-report artifact, and providing verification commands and results that document the installer telemetry/hook registration testing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch gra-370-smoke-artifact

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot added the docs label Jun 5, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@Gradata/docs/research/gra-370-installer-telemetry-smoke.md`:
- Around line 28-32: The verification command hardcodes the uv binary path
(/home/olive/.local/bin/uv); update the doc line that runs `env -u BRAIN_DIR -u
GRADATA_BRAIN /home/olive/.local/bin/uv run pytest ...` to invoke uv from PATH
(e.g., `uv run pytest ...`) and add an optional fallback note to use `python -m
uv run pytest ...` if uv is not on PATH; ensure the change is applied where the
tests `tests/test_install_smoke_matrix.py`, `tests/test_cli_install_agent.py`,
and `tests/test_hook_adapters.py` are referenced so the command is portable
across environments.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c6dab4cb-60ba-40b0-bfa4-3caf17dc7615

📥 Commits

Reviewing files that changed from the base of the PR and between d958235 and 6b80525.

📒 Files selected for processing (1)
  • Gradata/docs/research/gra-370-installer-telemetry-smoke.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
  • GitHub Check: pytest (py3.12)
  • GitHub Check: pytest (py3.11)
  • GitHub Check: pytest macos-latest / py3.12
  • GitHub Check: pytest ubuntu-latest / py3.12
  • GitHub Check: pytest ubuntu-latest / py3.11
  • GitHub Check: pytest windows-latest / py3.11
  • GitHub Check: pytest windows-latest / py3.12
  • GitHub Check: pytest macos-latest / py3.11
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: Gradata
Repo: Gradata/gradata PR: 0
File: :0-0
Timestamp: 2026-04-17T17:18:07.439Z
Learning: In PR `#102` (gradata/gradata), Round 2 addressed: cli.py env-first brain resolution (GRADATA_BRAIN > --brain-dir > cwd), _tenant.py corrupt .tenant_id overwrite, _env_int default clamping to minimum, and _events.py tenant-scoped fallback SELECT for dedup. All ruff and 99 tests green after these fixes.
📚 Learning: 2026-04-17T17:18:07.439Z
Learnt from: Gradata
Repo: Gradata/gradata PR: 0
File: :0-0
Timestamp: 2026-04-17T17:18:07.439Z
Learning: In PR `#102` (gradata/gradata), Round 2 addressed: cli.py env-first brain resolution (GRADATA_BRAIN > --brain-dir > cwd), _tenant.py corrupt .tenant_id overwrite, _env_int default clamping to minimum, and _events.py tenant-scoped fallback SELECT for dedup. All ruff and 99 tests green after these fixes.

Applied to files:

  • Gradata/docs/research/gra-370-installer-telemetry-smoke.md

Comment on lines +28 to +32
env -u BRAIN_DIR -u GRADATA_BRAIN /home/olive/.local/bin/uv run pytest \
tests/test_install_smoke_matrix.py \
tests/test_cli_install_agent.py \
tests/test_hook_adapters.py \
-q

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Make the verification command portable across environments.

The command currently hardcodes /home/olive/.local/bin/uv, which makes the smoke steps host-specific. Prefer invoking uv from PATH (or document a fallback like python -m uv) so others can reproduce it directly.

Proposed doc fix
-env -u BRAIN_DIR -u GRADATA_BRAIN /home/olive/.local/bin/uv run pytest \
+env -u BRAIN_DIR -u GRADATA_BRAIN uv run pytest \
   tests/test_install_smoke_matrix.py \
   tests/test_cli_install_agent.py \
   tests/test_hook_adapters.py \
   -q
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
env -u BRAIN_DIR -u GRADATA_BRAIN /home/olive/.local/bin/uv run pytest \
tests/test_install_smoke_matrix.py \
tests/test_cli_install_agent.py \
tests/test_hook_adapters.py \
-q
env -u BRAIN_DIR -u GRADATA_BRAIN uv run pytest \
tests/test_install_smoke_matrix.py \
tests/test_cli_install_agent.py \
tests/test_hook_adapters.py \
-q
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@Gradata/docs/research/gra-370-installer-telemetry-smoke.md` around lines 28 -
32, The verification command hardcodes the uv binary path
(/home/olive/.local/bin/uv); update the doc line that runs `env -u BRAIN_DIR -u
GRADATA_BRAIN /home/olive/.local/bin/uv run pytest ...` to invoke uv from PATH
(e.g., `uv run pytest ...`) and add an optional fallback note to use `python -m
uv run pytest ...` if uv is not on PATH; ensure the change is applied where the
tests `tests/test_install_smoke_matrix.py`, `tests/test_cli_install_agent.py`,
and `tests/test_hook_adapters.py` are referenced so the command is portable
across environments.

@Gradata Gradata merged commit 6d00ffd into main Jun 5, 2026
9 checks passed
@Gradata Gradata deleted the gra-370-smoke-artifact branch June 5, 2026 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant