feat: spit the model name in the reviews. (#16)

Author: sayakpaul

action.yml

@@ -97,6 +97,10 @@ inputs:
     description: 'Model context window (tokens) used for sizing.'
     required: false
     default: '200000'
+  staging:
+    description: 'Set to "true" to mark this as a staging deployment. Published reviews then carry a note saying they were posted from staging.'
+    required: false
+    default: 'false'
   github_token:
     description: 'Token with pull-requests:write. Defaults to the job token.'
     required: false
@@ -146,6 +150,7 @@ runs:
         CONTEXT_SCRIPT_TIMEOUT: ${{ inputs.context_script_timeout }}
         REPO_CHECKOUT_PATH: ${{ inputs.repo_checkout_path }}
         TOOL_MAX_ITERATIONS: ${{ inputs.tool_max_iterations }}
+        STAGING: ${{ inputs.staging }}
         HEADROOM_COMPRESS: ${{ inputs.headroom_compress }}
         HEADROOM_TARGET_RATIO: ${{ inputs.headroom_target_ratio }}
         HEADROOM_COMPRESS_USER_MESSAGES: ${{ inputs.headroom_compress_user_messages }}

docs/configuration.md

@@ -30,6 +30,7 @@ environment variables in server modes.
 | `DEFAULT_REVIEW_RULES` | `default_review_rules` | general Python correctness and security rules | Fallback when no rules file exists. |
 | `ALLOW_APPROVE` | none | `false` | Allows publishing `APPROVE` events in App/web mode. |
 | `PERSONA_HEADER` | none | `🤗 **Serge** says:` | Prefix for failure comments and bot messages. |
+| `STAGING` | `staging` | `false` | Marks a non-production deployment. Published reviews then carry a note that they were posted from staging. |
 
 ## Context Compression
 

reviewbot/config.py

@@ -83,6 +83,10 @@ class Config:
     # off, and skip any remaining diff chunks. Set to 0 to disable.
     llm_max_input_tokens: int = 2_000_000
 
+    # When true, published reviews carry a note that they came from a
+    # non-production (staging) deployment. Set via the STAGING env var.
+    is_staging: bool = False
+
     # Web-mode (reviewbot-web) settings. All optional in webhook/Action
     # modes; required only when require_web=True.
     github_oauth_client_id: Optional[str] = None
@@ -246,6 +250,7 @@ def from_env(
             # PRs complete without being forced to truncate.
             tool_max_iterations=_int_env("TOOL_MAX_ITERATIONS", 30),
             llm_max_input_tokens=_int_env("LLM_MAX_INPUT_TOKENS", 2_000_000),
+            is_staging=_bool_env("STAGING", False),
             github_oauth_client_id=oauth_client_id,
             github_oauth_client_secret=oauth_client_secret,
             github_oauth_callback_url=oauth_callback_url,

reviewbot/reviewer.py

@@ -99,6 +99,10 @@ class ReviewDraft:
     # metrics_line string.
     prompt_tokens: int = 0
     completion_tokens: int = 0
+    # Resolved LLM model id that produced this review (after endpoint
+    # auto-discovery, if llm_model was unset). Surfaced in the published
+    # review footer; None when no LLM call was made.
+    model: Optional[str] = None
 
 
 @dataclass
@@ -1322,6 +1326,7 @@ def _emit(kind: str, text: str) -> None:
         truncated_chunks=skipped_chunks_for_budget,
         prompt_tokens=total_metrics.prompt_tokens,
         completion_tokens=total_metrics.completion_tokens,
+        model=llm.model,
     )
 
 
@@ -1373,8 +1378,15 @@ def publish_review(
             f"budget; {draft.truncated_chunks} remaining diff chunk(s) were "
             "not reviewed._"
         )
+    if cfg.is_staging:
+        body += "\n\n_Note: posted from a staging deployment._"
+    footer_parts = []
+    if draft.model:
+        footer_parts.append(f"model: `{draft.model}`")
     if draft.metrics_line:
-        body += f"\n\n_{draft.metrics_line}_"
+        footer_parts.append(draft.metrics_line)
+    if footer_parts:
+        body += f"\n\n_{' · '.join(footer_parts)}_"
 
     gh.create_review(
         draft.owner,

reviewbot/store.py

@@ -636,6 +636,7 @@ def _encode_draft(draft: Optional[ReviewDraft]) -> Optional[str]:
             "event": draft.event,
             "rejected_count": draft.rejected_count,
             "metrics_line": draft.metrics_line,
+            "model": draft.model,
             "comments": [dataclasses.asdict(c) for c in draft.comments],
         },
         ensure_ascii=False,
@@ -667,6 +668,7 @@ def decode_draft(s: Optional[str]) -> Optional[ReviewDraft]:
         comments=comments,
         rejected_count=data.get("rejected_count", 0),
         metrics_line=data.get("metrics_line", ""),
+        model=data.get("model"),
     )
 
 

reviewbot/webapp.py

@@ -1834,6 +1834,7 @@ def _draft_to_dict(draft: ReviewDraft) -> dict[str, Any]:
         "event": draft.event,
         "rejected_count": draft.rejected_count,
         "metrics_line": draft.metrics_line,
+        "model": draft.model,
         "comments": [dataclasses.asdict(c) for c in draft.comments],
     }
 

tests/test_config.py

@@ -38,6 +38,22 @@ def test_respects_helper_tools_path_override(self) -> None:
 
         self.assertEqual(cfg.helper_tools_path, ".review/helpers.json")
 
+    def test_staging_defaults_off(self) -> None:
+        with patch.dict(os.environ, {"LLM_API_KEY": "token"}, clear=True):
+            cfg = Config.from_env(require_app=False)
+
+        self.assertFalse(cfg.is_staging)
+
+    def test_staging_enabled_via_env(self) -> None:
+        with patch.dict(
+            os.environ,
+            {"LLM_API_KEY": "token", "STAGING": "true"},
+            clear=True,
+        ):
+            cfg = Config.from_env(require_app=False)
+
+        self.assertTrue(cfg.is_staging)
+
 
 if __name__ == "__main__":
     unittest.main()

tests/test_publish_review.py

@@ -160,6 +160,42 @@ def test_rejected_count_note_in_body(self) -> None:
         body = gh.create_review.call_args.kwargs["body"]
         self.assertIn("3 suggested inline comment(s) were dropped", body)
 
+    def test_model_in_footer(self) -> None:
+        cfg = _make_cfg()
+        draft = _make_draft(model="acme/cool-model")
+        gh = MagicMock()
+        publish_review(cfg, gh, draft)
+        body = gh.create_review.call_args.kwargs["body"]
+        self.assertIn("model: `acme/cool-model`", body)
+        # Model and metrics share one footer line.
+        self.assertIn("model: `acme/cool-model` · 2 LLM turns", body)
+
+    def test_no_model_footer_when_unset(self) -> None:
+        cfg = _make_cfg()
+        draft = _make_draft(model=None)
+        gh = MagicMock()
+        publish_review(cfg, gh, draft)
+        body = gh.create_review.call_args.kwargs["body"]
+        self.assertNotIn("model:", body)
+        # Metrics line still renders on its own.
+        self.assertIn("2 LLM turns", body)
+
+    def test_staging_note_in_body(self) -> None:
+        cfg = _make_cfg(is_staging=True)
+        draft = _make_draft()
+        gh = MagicMock()
+        publish_review(cfg, gh, draft)
+        body = gh.create_review.call_args.kwargs["body"]
+        self.assertIn("posted from a staging deployment", body)
+
+    def test_no_staging_note_by_default(self) -> None:
+        cfg = _make_cfg()
+        draft = _make_draft()
+        gh = MagicMock()
+        publish_review(cfg, gh, draft)
+        body = gh.create_review.call_args.kwargs["body"]
+        self.assertNotIn("staging", body)
+
     def test_no_persona_header_when_disabled(self) -> None:
         cfg = _make_cfg(persona_header="")
         draft = _make_draft()