plugins: add new plugin for linking and unlinking issues to a PR #556

Amulyam24 · 2025-11-25T14:53:08Z

This PR adds a new plugin issue-management which has commands for linking and unlinking issues to a PR.
Ref - https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue

The commands can be used to link an issue to a PR in the current repository or in a different repository as well as handle multiple issues
This is done by adding the supported keyword Fixes to the body of the PR if it doesn't already exist or by appending the issue to the existing Fixes line
Supported formats are issue-number and org/repo-name#issue-number

A new plugin has been added to accommodate any existing issue commands or provide flexibility to support more issue commands in the future.

Fixes #359

netlify · 2025-11-25T14:53:14Z

✅ Deploy Preview for k8s-prow ready!

Name	Link
🔨 Latest commit	`c65a580`
🔍 Latest deploy log	https://app.netlify.com/projects/k8s-prow/deploys/692d60b9defd3a000813d3a3
😎 Deploy Preview	https://deploy-preview-556--k8s-prow.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

k8s-ci-robot · 2025-11-25T14:53:15Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Amulyam24
Once this PR has been reviewed and has the lgtm label, please assign cjwagner for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

stmcginnis · 2025-11-25T15:11:15Z

pkg/plugins/issue-management/issue_management.go

@@ -0,0 +1,95 @@
+/*
+Copyright 2025 The Kubernetes Authors.


Just FYI, current guidance is to not include the year for these copyright headers. I don't think it matters, just pointing it out to help spread awareness.

stmcginnis · 2025-11-25T15:12:30Z

pkg/plugins/issue-management/issue_management.go

+	unlinkIssueRegex = regexp.MustCompile(`(?mi)^/unlink-issue((?: +(?:\d+|[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+#\d+))+)\b`)
+)
+
+type githubClient interface {


I don't believe there is a reason for defining this interface unless you are going to mock it for unit testing. Is that planned as a follow up? Might be good to have that included in this PR.

Yes, I was planning that as a follow up. Sure, I'll add it to this PR.

Hi @stmcginnis, I explored a couple of ways on adding the UT.

At the end I feel having this interface and using the existing fake client is convenient than mocking the githubClient or using the plugins.PluginGitHubClient directly instead of githubClient as that would need mocking as well.

PTAL and let me know your thoughts!

Having a small local interface is somewhat established pattern in GH-facing plugins (retitle, blunderbuss), the GH client interface surface is massive and it is often useful to have an idea of what GH operations the plugin is limited to (besides the mentioned test mock use case). I'd prefer to keep it.

k8s-ci-robot · 2025-11-27T14:33:17Z

@Amulyam24: The label(s) `/label do-not-merge/work-in-progress

cannot be applied. These labels are supported:api-review, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, team/katacoda, refactor, ci-short, ci-extended, ci-full. Is this label configured under labels -> additional_labelsorlabels -> restricted_labelsinplugin.yaml`?

In response to this:

/label do-not-merge/work-in-progress

Adding UT

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Amulyam24 · 2025-11-27T14:33:49Z

/hold

WIP: Adding UT

This PR adds a new plugin issue-management which has commands for linking and unlinking issues to a PR. - The commands can be used to link an issue to a PR in the current repository or in a different repository as well as handle multiple issues - This is done by adding the supported keyword Fixes to the body of the PR if it doesn't already exist or by appending the issue to the existing Fixes line - Supported formats are issue-number and org/repo-name#issue-number Signed-off-by: Amulyam24 <amulmek1@in.ibm.com>

Amulyam24 · 2025-12-01T09:41:02Z

/unhold

petr-muller · 2025-12-01T16:59:09Z

pkg/plugins/issue-management/issue_management.go

+	unlinkIssueRegex = regexp.MustCompile(`(?mi)^/unlink-issue((?: +(?:\d+|[a-zA-Z0-9_.-]+/[a-zA-Z0-9_.-]+#\d+))+)\b`)
+)
+
+type githubClient interface {


Having a small local interface is somewhat established pattern in GH-facing plugins (retitle, blunderbuss), the GH client interface surface is massive and it is often useful to have an idea of what GH operations the plugin is limited to (besides the mentioned test mock use case). I'd prefer to keep it.

petr-muller · 2025-12-01T17:24:17Z

pkg/plugins/issue-management/issue_management.go

+		log.WithFields(logrus.Fields{
+			"org":    e.Repo.Owner.Login,
+			"repo":   e.Repo.Name,
+			"number": e.Number,
+			"user":   e.User.Login,


let's make this logrus.Fieds instance in handleGenericComment and pass it to here with pc.Logger.WithFields, then this method already gets a populated logger and can just log.Info the necessary message

petr-muller · 2025-12-01T17:27:59Z

pkg/plugins/issue-management/link-issue.go

+	regex := linkIssueRegex
+	if !linkIssue {
+		regex = unlinkIssueRegex
+	}
+
+	matches := regex.FindStringSubmatch(e.Body)
+	if len(matches) == 0 {
+		return nil
+	}
+
+	issues := strings.Fields(matches[1])
+	if len(issues) == 0 {
+		log.Info("No issue references provided in the comment.")
+		return nil
+	}


so we first do a MatchString at the callsite (in handleIssues), set a boolean based on that, then we use that boolean to select the regex again and match it again with FindStringSubmatch

feels like we can do all this at the callsite (in handleIssues) and just pass issues to this method (in addition to the link/unlink boolean)

petr-muller · 2025-12-01T17:31:08Z

pkg/plugins/issue-management/link-issue.go

+	}
+
+	// Handling issue references in format org/repo#issue-number
+	if strings.Contains(issue, "/") {


nit: would slightly prefer making this a standard guard clause

Suggested change

if strings.Contains(issue, "/") {

if !strings.Contains(issue, "/") {

return nil, fmt.Errorf("unrecognized issue reference: %s", issue)

}

parts := strings.Split(issue, "#")

...

return &IssueRef{Org: orgRepo[0], Repo: orgRepo[1], Num: num}, nil

petr-muller · 2025-12-01T17:40:52Z

pkg/plugins/issue-management/link-issue.go

+
+	newBody := updateFixesLine(pr.Body, issueRefs, linkIssue)
+	if newBody == pr.Body {
+		log.Info("PR body is already up-to-date. No changes needed.")


pls downgrade to debug

petr-muller · 2025-12-01T17:47:54Z

pkg/plugins/issue-management/issue_management.go

+	case unlinkIssueRegex.MatchString(e.Body):
+		log.WithFields(logrus.Fields{
+			"org":    e.Repo.Owner.Login,
+			"repo":   e.Repo.Name,
+			"number": e.Number,
+			"user":   e.User.Login,
+		}).Info("Handling unlink issue command")
+		return handleLinkIssue(gc, log, e, false)


hmmm this means the user can either say /link or say /unlink but not both; if they do both, then only the /link will count. But these operations are sometimes symmetrical, let's say you make a typo and link something wrong, then you'd probably want to fix it like this:

/unlink wrong /link right

So I think we should have something like a method that is given a comment body and it produces issues to add links to, and issues to remove links to, and then we'd pass both to handleLinkIssue instead of the add boolean`:

toLink, to unlink := parseCommentForLinkCommands(...) if len(toLink) == 0 && len(toUnlink) == 0 { return nothing to do } return handleLinkIssue(..., toLink, toUnlink)

petr-muller · 2025-12-01T17:48:39Z

pkg/plugins/issue-management/link-issue.go

+		// If repo in issue reference is different from the PR, check if it exists
+		if repo != issueRef.Repo {
+			if _, err := gc.GetRepo(issueRef.Org, issueRef.Repo); err != nil {
+				return fmt.Errorf("failed to get repo: %w", err)


collect errors and respond with summary comment

petr-muller · 2025-12-01T17:48:45Z

pkg/plugins/issue-management/link-issue.go

+		// Verify if the issue exists
+		fetchedIssue, err := gc.GetIssue(issueRef.Org, issueRef.Repo, issueRef.Num)
+		if err != nil {
+			return fmt.Errorf("failed to get issue: %w", err)


collect errors and respond with summary comment

petr-muller · 2025-12-01T17:48:53Z

pkg/plugins/issue-management/link-issue.go

+		}
+		if fetchedIssue.IsPullRequest() {
+			response := fmt.Sprintf("Skipping #%d of repo **%s** and org **%s** as it is a *pull request*.", fetchedIssue.Number, issueRef.Repo, issueRef.Org)
+			if err := gc.CreateComment(org, repo, number, plugins.FormatResponseRaw(e.Body, e.HTMLURL, user, response)); err != nil {


collect errors and respond with summary comment

petr-muller · 2025-12-01T17:58:05Z

pkg/plugins/issue-management/link-issue.go

+	return fmt.Sprintf("%s/%s#%d", ref.Org, ref.Repo, ref.Num)
+}
+
+func updateFixesLine(body string, issueRefs []string, add bool) string {


now if this is changed to the toLink / toUnlink concept I propsed above, then I think we can use sets to compute the resulting issues that the pr should have links to: existing.Difference(toUnlink).Union(toLink)

petr-muller · 2025-12-01T18:04:34Z

pkg/plugins/issue-management/link-issue.go

+		}
+
+		// If repo in issue reference is different from the PR, check if it exists
+		if repo != issueRef.Repo {


Suggested change

if repo != issueRef.Repo {

if org != issueRef.Org || repo != issueRef.Repo {

I think we need to do the same if the repo name is the same but org differs (like in a fork)

petr-muller · 2025-12-01T18:05:51Z

I think this is pretty close, I appreciate the test coverage. Left some comment about the code structure.

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. area/hook Issues or PRs related to prow's hook component labels Nov 25, 2025

k8s-ci-robot requested review from MadhavJivrajani, Priyankasaggu11929, cjwagner and petr-muller November 25, 2025 14:53

k8s-ci-robot added area/plugins Issues or PRs related to prow's plugins for the hook component size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 25, 2025

Amulyam24 force-pushed the issues-plugin branch from 2dc443d to 30cf25e Compare November 25, 2025 14:53

stmcginnis reviewed Nov 25, 2025

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 27, 2025

Amulyam24 force-pushed the issues-plugin branch from 30cf25e to 427609d Compare November 28, 2025 09:40

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 28, 2025

Amulyam24 force-pushed the issues-plugin branch 3 times, most recently from 2419527 to afde1e0 Compare December 1, 2025 06:35

Amulyam24 force-pushed the issues-plugin branch from afde1e0 to c65a580 Compare December 1, 2025 09:32

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 1, 2025

petr-muller reviewed Dec 1, 2025

View reviewed changes

-	if strings.Contains(issue, "/") {
+	if !strings.Contains(issue, "/") {
+	  return nil, fmt.Errorf("unrecognized issue reference: %s", issue)
+	}
+	parts := strings.Split(issue, "#")
+	...
+	return &IssueRef{Org: orgRepo[0], Repo: orgRepo[1], Num: num}, nil

	if repo != issueRef.Repo {
	if org != issueRef.Org \|\| repo != issueRef.Repo {

plugins: add new plugin for linking and unlinking issues to a PR #556

Are you sure you want to change the base?

plugins: add new plugin for linking and unlinking issues to a PR #556

Conversation

Amulyam24 commented Nov 25, 2025

Uh oh!

netlify bot commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for k8s-prow ready!

Uh oh!

k8s-ci-robot commented Nov 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Nov 27, 2025

Uh oh!

Amulyam24 commented Nov 27, 2025

Uh oh!

Amulyam24 commented Dec 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

petr-muller commented Dec 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify bot commented Nov 25, 2025 •

edited

Loading