Skip to content

fix: add missing import and update tests for branch template feature #799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashwin-ant merged 2 commits into from
Jan 8, 2026
Merged

fix: add missing import and update tests for branch template feature #799

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4db72b5
fix: add missing import and update tests for branch template feature
ashwin-ant Jan 8, 2026
290f24d
address review feedback: update comment and add truncation test
ashwin-ant Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/github/operations/branch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
* - For Issues: Create a new branch
*/

import { $ } from "bun";
import { execFileSync } from "child_process";
import * as core from "@actions/core";
import type { ParsedGitHubContext } from "../context";
Expand Down
5 changes: 4 additions & 1 deletion src/utils/branch-template.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@ const NUM_DESCRIPTION_WORDS = 5;
/**
* Extracts the first `numWords` words from a title and converts them to kebab-case
*/
Copy link
Contributor

@claude claude bot Jan 8, 2026

Choose a reason for hiding this comment

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

The comment should explicitly state "5 words" instead of using the generic placeholder `numWords`. Given that confusion around this constant caused the bug in PR #571, being explicit will prevent future issues:

/**
 * Extracts the first 5 words from a title and converts them to kebab-case
 * (or fewer if numWords parameter is provided)
 */

function extractDescription(title: string, numWords: number = NUM_DESCRIPTION_WORDS): string {
function extractDescription(
title: string,
numWords: number = NUM_DESCRIPTION_WORDS,
): string {
if (!title || title.trim() === "") {
return "";
}
Expand Down
8 changes: 5 additions & 3 deletions test/branch-template.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ describe("branch template utilities", () => {
"Fix login bug with OAuth",
Copy link
Contributor

@claude claude bot Jan 8, 2026

Choose a reason for hiding this comment

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

Consider adding a test with a title containing more than 5 words to explicitly verify truncation behavior:

it("should truncate descriptions to exactly 5 words from longer titles", () => {
  const result = generateBranchName(
    "{{prefix}}{{description}}/{{entityNumber}}",
    "feature/",
    "issue",
    999,
    undefined,
    undefined,
    "This is a very long title with many more than five words in it"
  );
  expect(result).toBe("feature/this-is-a-very-long/999");
});

This would definitively verify the NUM_DESCRIPTION_WORDS=5 change is working correctly.

);

expect(result).toBe("feature/fix-login-bug/123");
expect(result).toBe("feature/fix-login-bug-with-oauth/123");
});

it("should handle template with multiple variables including description", () => {
Expand All @@ -172,7 +172,9 @@ describe("branch template utilities", () => {
"User authentication fails completely",
);

expect(result).toBe("dev/bug/user-authentication-fails-issue_456");
expect(result).toBe(
"dev/bug/user-authentication-fails-completely-issue_456",
);
});

it("should handle description with special characters in template", () => {
Expand All @@ -187,7 +189,7 @@ describe("branch template utilities", () => {
"Add: User Registration & Email Validation",
);

expect(result).toBe("fix/add-user-registration-789");
expect(result).toBe("fix/add-user-registration-email-789");
});

it("should handle empty description in template", () => {
Expand Down
1 change: 1 addition & 0 deletions test/pull-request-target.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ describe("pull_request_target event support", () => {
},
comments: { nodes: [] },
reviews: { nodes: [] },
labels: { nodes: [] },
},
comments: [],
changedFiles: [],
Expand Down
Loading