wip

Author: edulix

docs/doc/usage.md

@@ -86,13 +86,17 @@ release-tool publish 9.1.0
 
 # Or explicitly specify a notes file
 release-tool publish 9.1.0 -f .release_tool_cache/draft-releases/owner-repo/9.1.0.md
+
+# Associate with a specific GitHub issue/ticket
+release-tool publish 9.1.0 --ticket 123
 ```
 
 This will:
 - Auto-find draft release notes (or use specified file)
 - Create a git tag `v9.1.0`
 - Create a GitHub release with the release notes
 - Optionally create a PR with release notes (use `--pr`)
+- Optionally associate with a GitHub issue for tracking (use `--ticket`)
 
 #### Testing Before Publishing
 
@@ -171,6 +175,7 @@ release-tool publish 9.1.0 --prerelease auto  # Auto-detect
 | `list-releases` | Lists releases from the database with filters |
 | `publish <version>` | Creates a GitHub release (auto-finds draft notes) |
 | `publish <version> -f <file>` | Creates a GitHub release from a markdown file |
+| `publish <version> --ticket <number>` | Associate release with a GitHub issue |
 | `publish --list` or `publish -l` | List all available draft releases |
 | `publish --dry-run` | Preview publish operation without making changes |
 | `publish --debug` | Show detailed debugging information |

src/release_tool/commands/publish.py

@@ -377,10 +377,11 @@ def _display_draft_releases(draft_files: list[Path], title: str = "Draft Release
 @click.option('--prerelease', type=click.Choice(['auto', 'true', 'false'], case_sensitive=False), default=None,
               help='Mark as prerelease: auto (detect from version), true, or false (default: from config)')
 @click.option('--force', type=click.Choice(['none', 'draft', 'published'], case_sensitive=False), default='none', help='Force overwrite existing release (default: none)')
+@click.option('--ticket', type=int, default=None, help='Ticket/issue number to associate with this release')
 @click.option('--dry-run', is_flag=True, help='Show what would be published without making changes')
 @click.pass_context
 def publish(ctx, version: Optional[str], list_drafts: bool, delete_drafts: bool, notes_file: Optional[str], create_release: Optional[bool],
-           create_pr: Optional[bool], release_mode: Optional[str], prerelease: Optional[str], force: str,
+           create_pr: Optional[bool], release_mode: Optional[str], prerelease: Optional[str], force: str, ticket: Optional[int],
            dry_run: bool):
     """
     Publish a release to GitHub.
@@ -914,13 +915,32 @@ def publish(ctx, version: Optional[str], list_drafts: bool, delete_drafts: bool,
                 # Create release tracking ticket if enabled
                 ticket_result = None
 
-                # If force=draft, try to find existing ticket interactively first if not in DB
-                if config.output.create_ticket and force == 'draft' and not dry_run:
+                # If ticket number provided explicitly, use it directly
+                if config.output.create_ticket and ticket and not dry_run:
+                    try:
+                        issue = github_client.gh.get_repo(issues_repo).get_issue(ticket)
+                        ticket_result = {'number': str(issue.number), 'url': issue.html_url}
+                        console.print(f"[blue]Using provided ticket #{ticket}[/blue]")
+                        # Save association to database
+                        db.save_ticket_association(
+                            repo_full_name=repo_name,
+                            version=version,
+                            ticket_number=ticket,
+                            ticket_url=issue.html_url
+                        )
+                        if debug:
+                            console.print(f"[dim]Saved ticket association to database[/dim]")
+                    except Exception as e:
+                        console.print(f"[yellow]Warning: Could not use ticket #{ticket}: {e}[/yellow]")
+                        ticket_result = None
+                
+                # If force=draft, try to find existing ticket automatically (non-interactive)
+                if config.output.create_ticket and force == 'draft' and not dry_run and not ticket_result:
                      existing_association = db.get_ticket_association(repo_name, version)
                      if not existing_association:
-                         ticket_result = _find_existing_ticket_interactive(config, github_client, version)
+                         ticket_result = _find_existing_ticket_auto(config, github_client, version, debug)
                          if ticket_result:
-                             console.print(f"[blue]Reusing existing ticket #{ticket_result['number']}[/blue]")
+                             console.print(f"[blue]Auto-selected open ticket #{ticket_result['number']}[/blue]")
                              # Save association
                              db.save_ticket_association(
                                 repo_full_name=repo_name,
@@ -1171,35 +1191,27 @@ def publish(ctx, version: Optional[str], list_drafts: bool, delete_drafts: bool,
             db.close()
 
 
-def _find_existing_ticket_interactive(config: Config, github_client: GitHubClient, version: str) -> Optional[dict]:
-    """Find existing ticket interactively."""
+def _find_existing_ticket_auto(config: Config, github_client: GitHubClient, version: str, debug: bool = False) -> Optional[dict]:
+    """Find existing ticket automatically (non-interactive, picks first open ticket)."""
     issues_repo = _get_issues_repo(config)
-    query = f"repo:{issues_repo} is:issue {version} in:title"
-    console.print(f"[cyan]Searching for existing tickets in {issues_repo}...[/cyan]")
+    # Search only for OPEN issues
+    query = f"repo:{issues_repo} is:issue is:open {version} in:title"
+    
+    if debug:
+        console.print(f"[dim]Searching for open tickets matching version {version}...[/dim]")
 
-    # We need to use the underlying github client to search
-    # This is a bit of a hack, but we don't have a search method in GitHubClient
-    # Assuming github_client.gh is available
+    # Search for open issues matching the version
     issues = list(github_client.gh.search_issues(query)[:5])
 
     if not issues:
-        console.print("[yellow]No matching tickets found.[/yellow]")
+        if debug:
+            console.print("[dim]No matching open tickets found.[/dim]")
         return None
-        
-    table = Table(title="Found Tickets")
-    table.add_column("#", style="cyan")
-    table.add_column("Number", style="green")
-    table.add_column("Title", style="white")
-    table.add_column("State", style="yellow")
 
-    for i, issue in enumerate(issues):
-        table.add_row(str(i+1), str(issue.number), issue.title, issue.state)
-        
-    console.print(table)
+    # Automatically use the first open ticket found
+    selected = issues[0]
 
-    response = input("\nSelect ticket to reuse (1-5) or 'n' to create new: ").strip().lower()
-    if response.isdigit() and 1 <= int(response) <= len(issues):
-        selected = issues[int(response)-1]
-        return {'number': str(selected.number), 'url': selected.html_url}
-        
-    return None
+    if debug:
+        console.print(f"[dim]Found open ticket #{selected.number}: {selected.title}[/dim]")
+    
+    return {'number': str(selected.number), 'url': selected.html_url}

tests/test_publish.py

@@ -698,3 +698,124 @@ def test_branch_creation_disabled_by_config(test_config, test_notes_file):
         # Should succeed (but will likely fail at GitHub release creation due to missing branch)
         # For this test we're just verifying branch creation was skipped
         assert result.exit_code == 0
+
+
+def test_ticket_parameter_associates_with_issue(test_config, test_notes_file):
+    """Test that --ticket parameter properly associates release with a GitHub issue."""
+    runner = CliRunner()
+    
+    with patch('release_tool.commands.publish.GitHubClient') as mock_gh_client, \
+         patch('release_tool.commands.publish.GitOperations') as mock_git_ops, \
+         patch('release_tool.commands.publish.determine_release_branch_strategy') as mock_strategy, \
+         patch('release_tool.commands.publish.Database') as mock_db_class:
+        
+        # Mock database
+        mock_db = MagicMock()
+        mock_db_class.return_value = mock_db
+        mock_db.get_repository.return_value = None
+        mock_db.get_ticket_association.return_value = None  # No existing association
+        
+        # Mock git operations
+        mock_git_instance = MagicMock()
+        mock_git_ops.return_value = mock_git_instance
+        mock_git_instance.get_version_tags.return_value = []
+        mock_git_instance.tag_exists.return_value = False
+        mock_git_instance.branch_exists.return_value = True
+        
+        # Mock strategy
+        mock_strategy.return_value = ("release/0.0", "main", False)
+        
+        # Mock GitHub client
+        mock_gh_instance = MagicMock()
+        mock_gh_client.return_value = mock_gh_instance
+        mock_gh_instance.create_release.return_value = "https://github.com/test/repo/releases/tag/v0.0.1"
+        
+        # Mock the issue retrieval
+        mock_issue = MagicMock()
+        mock_issue.number = 123
+        mock_issue.html_url = "https://github.com/test/repo/issues/123"
+        mock_gh_instance.gh.get_repo.return_value.get_issue.return_value = mock_issue
+        
+        # Enable ticket creation and PR creation in config
+        test_config.output.create_ticket = True
+        test_config.output.create_pr = True
+        
+        result = runner.invoke(
+            publish,
+            ['0.0.1', '-f', str(test_notes_file), '--release', '--pr', '--ticket', '123'],
+            obj={'config': test_config}
+        )
+        
+        assert result.exit_code == 0
+        
+        # Verify the issue was retrieved (can be called multiple times during PR creation)
+        mock_gh_instance.gh.get_repo.return_value.get_issue.assert_called_with(123)
+        
+        # Verify the ticket association was saved to database
+        assert mock_db.save_ticket_association.called
+        # Find the call with ticket_number=123
+        calls = [call for call in mock_db.save_ticket_association.call_args_list 
+                 if 'ticket_number' in call[1] and call[1]['ticket_number'] == 123]
+        assert len(calls) > 0
+        call_args = calls[0]
+        assert call_args[1]['version'] == '0.0.1'
+        assert call_args[1]['ticket_url'] == "https://github.com/test/repo/issues/123"
+
+
+def test_auto_select_open_ticket_for_draft_release(test_config, test_notes_file):
+    """Test that publishing with --force draft auto-selects the first open ticket."""
+    runner = CliRunner()
+    
+    with patch('release_tool.commands.publish.GitHubClient') as mock_gh_client, \
+         patch('release_tool.commands.publish.GitOperations') as mock_git_ops, \
+         patch('release_tool.commands.publish.determine_release_branch_strategy') as mock_strategy, \
+         patch('release_tool.commands.publish.Database') as mock_db_class, \
+         patch('release_tool.commands.publish._find_existing_ticket_auto') as mock_find_ticket:
+        
+        # Mock database
+        mock_db = MagicMock()
+        mock_db_class.return_value = mock_db
+        mock_db.get_repository.return_value = None
+        mock_db.get_ticket_association.return_value = None  # No existing association
+        
+        # Mock git operations
+        mock_git_instance = MagicMock()
+        mock_git_ops.return_value = mock_git_instance
+        mock_git_instance.get_version_tags.return_value = []
+        mock_git_instance.tag_exists.return_value = False
+        mock_git_instance.branch_exists.return_value = True
+        
+        # Mock strategy
+        mock_strategy.return_value = ("release/0.0", "main", False)
+        
+        # Mock GitHub client
+        mock_gh_instance = MagicMock()
+        mock_gh_client.return_value = mock_gh_instance
+        mock_gh_instance.create_release.return_value = "https://github.com/test/repo/releases/tag/v0.0.1-rc.0"
+        
+        # Mock automatic ticket finding (returns first open ticket)
+        mock_find_ticket.return_value = {
+            'number': '456',
+            'url': 'https://github.com/test/repo/issues/456'
+        }
+        
+        # Enable ticket creation and PR creation in config
+        test_config.output.create_ticket = True
+        test_config.output.create_pr = True
+        
+        result = runner.invoke(
+            publish,
+            ['0.0.1-rc.0', '-f', str(test_notes_file), '--release', '--pr', '--force', 'draft'],
+            obj={'config': test_config}
+        )
+        
+        assert result.exit_code == 0
+        
+        # Verify auto-selection was called
+        mock_find_ticket.assert_called_once()
+        
+        # Verify the ticket association was saved
+        mock_db.save_ticket_association.assert_called()
+        call_args = mock_db.save_ticket_association.call_args
+        assert call_args[1]['ticket_number'] == 456
+        assert call_args[1]['version'] == '0.0.1-rc.0'