github-haystack 1.0.0__tar.gz → 1.1.0__tar.gz

github_haystack-1.1.0/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [integrations/github-v1.0.1] - 2025-06-12
+
+### 🐛 Bug Fixes
+
+- Prompts and schemas of GitHubIssueCommenterTool and GitHubIssueViewerTool now properly explain url parameter (#1929)
+
+
+### 🧹 Chores
+
+- Align core-integrations Hatch scripts (#1898)
+
+## [integrations/github-v1.0.0] - 2025-05-28
+
+### 🚀 Features
+
+- Add GitHub integration with components, tools, and prompts (#1637)
+
+<!-- generated by git-cliff -->

{github_haystack-1.0.0 → github_haystack-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: github-haystack
-Version: 1.0.0
+Version: 1.1.0
 Summary: Haystack components for interacting with GitHub repositories
 Project-URL: Source, https://github.com/deepset-ai/haystack-core-integrations/github
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/blob/main/integrations/github/README.md

{github_haystack-1.0.0 → github_haystack-1.1.0}/pyproject.toml

@@ -43,41 +43,38 @@ git_describe_command = 'git describe --tags --match="integrations/github-v[0-9]*
 
 [tool.hatch.envs.default]
 installer = "uv"
-dependencies = [
-  "coverage[toml]>=6.5",
-  "pytest",
-  "pytest-rerunfailures",
-  "haystack-pydoc-tools",
-  "pytz",
-  ]
-  
+dependencies = ["haystack-pydoc-tools", "ruff"]
+
 [tool.hatch.envs.default.scripts]
-test = "pytest {args:tests}"
-test-cov = "coverage run -m pytest {args:tests}"
-test-cov-retry = "test-cov --reruns 3 --reruns-delay 30 -x"
-cov-report = ["- coverage combine", "coverage report"]
-cov = ["test-cov", "cov-report"]
-cov-retry = ["test-cov-retry", "cov-report"]
 docs = ["pydoc-markdown pydoc/config.yml"]
-fix = "ruff check --fix"
+fmt = "ruff check --fix {args} && ruff format {args}"
+fmt-check = "ruff check {args} && ruff format --check {args}"
 
-[tool.hatch.envs.lint]
-installer = "uv"
-detached = true
-dependencies = ["pip", "black>=23.1.0", "mypy>=1.0.0", "ruff>=0.0.243"]
-[tool.hatch.envs.lint.scripts]
-typing = "mypy --install-types --non-interactive --explicit-package-bases {args:src/ tests}"
-style = [
-  "ruff check {args:}",
-  "black --check --diff {args:.}",
+[tool.hatch.envs.test]
+dependencies = [
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "pytest-rerunfailures",
+    "mypy",
+    "pip"
 ]
-fmt = ["black {args:.}", "ruff check --fix {args:}", "style"]
-all = ["style", "typing"]
 
-[tool.black]
-target-version = ["py38"]
-line-length = 120
-skip-string-normalization = true
+[tool.hatch.envs.test.scripts]
+unit = 'pytest -m "not integration" {args:tests}'
+integration = 'pytest -m "integration" {args:tests}'
+all = 'pytest {args:tests}'
+cov-retry = 'all --cov=haystack_integrations --reruns 3 --reruns-delay 30 -x'
+
+types = """mypy -p haystack_integrations.components.connectors.github \
+-p haystack_integrations.prompts.github \
+-p haystack_integrations.tools.github {args}"""
+
+[tool.mypy]
+install_types = true
+non_interactive = true
+check_untyped_defs = true
+disallow_incomplete_defs = true
 
 [tool.ruff]
 target-version = "py38"
@@ -155,22 +152,9 @@ omit = ["*/tests/*", "*/__init__.py"]
 show_missing = true
 exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
 
-
-[[tool.mypy.overrides]]
-module = [
-  "github.*",
-  "haystack.*",
-  "haystack_integrations.*",
-  "openai.*",
-  "pytest.*",
-  "numpy.*",
-]
-ignore_missing_imports = true
-
 [tool.pytest.ini_options]
 addopts = "--strict-markers"
 markers = [
   "integration: integration tests",
-  "unit: unit tests",
 ]
 log_cli = true

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/components/connectors/github/repo_forker.py

@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 import re
+import time
 from typing import Any, Dict, Optional
 
 import requests
@@ -274,8 +275,6 @@ class GitHubRepoForker:
 
             # Wait for fork completion if requested
             if self.wait_for_completion:
-                import time
-
                 start_time = time.time()
 
                 while time.time() - start_time < self.max_wait_seconds:

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/prompts/github/issue_commenter_prompt.py

@@ -4,18 +4,20 @@
 ISSUE_COMMENTER_PROMPT = """Haystack-Agent uses this tool to post a comment to a GitHub-issue discussion.
 
 <usage>
-Pass a `comment` string to post a comment.
+Pass a `comment` string and a `url` string to post a comment to a GitHub issue.
 </usage>
 
 IMPORTANT
-Haystack-Agent MUST pass "comment" to this tool. Otherwise, comment creation fails.
-Haystack-Agent always passes the contents of the comment to the "comment" parameter when calling this tool.
+Haystack-Agent MUST pass "comment" and "url" to this tool. Otherwise, comment creation fails.
+Haystack-Agent always passes the contents of the comment to the "comment" parameter and
+ the URL of the GitHub issue to the "url" parameter when calling this tool.
 """
 
 ISSUE_COMMENTER_SCHEMA = {
     "properties": {
-        "comment": {"type": "string", "description": "The contents of the comment that you want to create."}
+        "comment": {"type": "string", "description": "The contents of the comment that you want to create."},
+        "url": {"type": "string", "description": "URL of the GitHub issue to comment on."},
     },
-    "required": ["comment"],
+    "required": ["comment", "url"],
     "type": "object",
 }

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/prompts/github/issue_viewer_prompt.py

@@ -5,21 +5,21 @@ ISSUE_VIEWER_PROMPT = """Haystack-Agent uses this tool to view a GitHub issue.
 Haystack-Agent can view one issue at a time.
 
 <usage>
-Pass an `issue_url` string for the GitHub issue that you want to view.
-It is required to pass `issue_url` to use this tool.
+Pass an `url` string for the GitHub issue that you want to view.
+It is required to pass `url` to use this tool.
 The structure is "https://github.com/repo-owner/repo-name/issues/issue-number".
 
 Examples:
 
-- {"issue_url": "https://github.com/deepset-ai/haystack/issues/9343"}
+- {"url": "https://github.com/deepset-ai/haystack/issues/9343"}
     - will show you the issue 9343 of the haystack repository
-- {"issue_url": "https://github.com/deepset-ai/haystack-core-integrations/issues/1685"}
+- {"url": "https://github.com/deepset-ai/haystack-core-integrations/issues/1685"}
     - will show you the issue 1685 of the haystack-core-integrations repository
 </usage>
 """
 
 ISSUE_VIEWER_SCHEMA = {
-    "properties": {"issue_url": {"type": "string", "description": "URL of the GitHub issue to link the PR to."}},
-    "required": ["issue_url"],
+    "properties": {"url": {"type": "string", "description": "URL of the GitHub issue to link the PR to."}},
+    "required": ["url"],
     "type": "object",
 }

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/tools/github/file_editor_tool.py

@@ -62,9 +62,6 @@ class GitHubFileEditorTool(ComponentTool):
                 "documents": {"handler": custom_handler}
             }
         """
-        self.name = name
-        self.description = description
-        self.parameters = parameters
         self.github_token = github_token
         self.repo = repo
         self.branch = branch

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/tools/github/issue_commenter_tool.py

@@ -60,9 +60,6 @@ class GitHubIssueCommenterTool(ComponentTool):
                 "documents": {"handler": custom_handler}
             }
         """
-        self.name = name
-        self.description = description
-        self.parameters = parameters
         self.github_token = github_token
         self.raise_on_failure = raise_on_failure
         self.retry_attempts = retry_attempts

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/tools/github/issue_viewer_tool.py

@@ -60,9 +60,6 @@ class GitHubIssueViewerTool(ComponentTool):
                 "documents": {"handler": custom_handler}
             }
         """
-        self.name = name
-        self.description = description
-        self.parameters = parameters
         self.github_token = github_token
         self.raise_on_failure = raise_on_failure
         self.retry_attempts = retry_attempts

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/tools/github/pr_creator_tool.py

@@ -58,9 +58,6 @@ class GitHubPRCreatorTool(ComponentTool):
                 "documents": {"handler": custom_handler}
             }
         """
-        self.name = name
-        self.description = description
-        self.parameters = parameters
         self.github_token = github_token
         self.raise_on_failure = raise_on_failure
         self.outputs_to_string = outputs_to_string

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/tools/github/repo_viewer_tool.py

@@ -67,9 +67,6 @@ class GitHubRepoViewerTool(ComponentTool):
                 "documents": {"handler": custom_handler}
             }
         """
-        self.name = name
-        self.description = description
-        self.parameters = parameters
         self.github_token = github_token
         self.repo = repo
         self.branch = branch

{github_haystack-1.0.0 → github_haystack-1.1.0}/src/haystack_integrations/tools/github/utils.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-from typing import Any, Callable, Dict, List, Union
+from typing import Any, Callable, Dict, List, Optional, Union
 
 from haystack import Document
 from haystack.utils.callable_serialization import deserialize_callable, serialize_callable
@@ -20,10 +20,10 @@ def message_handler(documents: List[Document], max_length: int = 150_000) -> str
     result_str = ""
     for document in documents:
         if document.meta["type"] in ["file", "dir", "error"]:
-            result_str += document.content + "\n"
+            result_str += document.content or "" + "\n"
         else:
             result_str += f"File Content for {document.meta['path']}\n\n"
-            result_str += document.content
+            result_str += document.content or ""
 
     if len(result_str) > max_length:
         result_str = result_str[:max_length] + "...(large file can't be fully displayed)"
@@ -33,8 +33,8 @@ def message_handler(documents: List[Document], max_length: int = 150_000) -> str
 
 def serialize_handlers(
     serialized: Dict[str, Any],
-    outputs_to_state: Dict[str, Dict[str, Union[str, Callable]]],
-    outputs_to_string: Dict[str, Union[str, Callable[[Any], str]]],
+    outputs_to_state: Optional[Dict[str, Dict[str, Union[str, Callable]]]],
+    outputs_to_string: Optional[Dict[str, Union[str, Callable[[Any], str]]]],
 ) -> None:
     """
     Serializes callable handlers in outputs_to_state and outputs_to_string.
@@ -48,12 +48,18 @@ def serialize_handlers(
         for key, config in outputs_to_state.items():
             serialized_config = config.copy()
             if "handler" in config:
+                if not callable(config["handler"]):
+                    msg = f"Handler for outputs_to_state[{key}] is not a callable"
+                    raise ValueError(msg)
                 serialized_config["handler"] = serialize_callable(config["handler"])
             serialized_outputs[key] = serialized_config
         serialized["outputs_to_state"] = serialized_outputs
 
     if outputs_to_string is not None and "handler" in outputs_to_string:
         serialized_string = outputs_to_string.copy()
+        if not callable(outputs_to_string["handler"]):
+            msg = "Handler for outputs_to_string is not a callable"
+            raise ValueError(msg)
         serialized_string["handler"] = serialize_callable(outputs_to_string["handler"])
         serialized["outputs_to_string"] = serialized_string