Skip to content
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.

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

Display linked issue(s) from the PR Overview #5824

Open
mohamedamara1 opened this issue Mar 10, 2024 · 6 comments · May be fixed by #5825
Open

Display linked issue(s) from the PR Overview #5824

mohamedamara1 opened this issue Mar 10, 2024 · 6 comments · May be fixed by #5825
Labels
feature-request Request for new features or functionality

Comments

@mohamedamara1
Copy link
Contributor

mohamedamara1 commented Mar 10, 2024

This is feature request to adding the ability to link an issue(s) to a PR from the PR Overview in the sidebar just like in Github,
I often find myself doing this.

I would like to also work on this if possible .

image

image

@mohamedamara1 mohamedamara1 linked a pull request Mar 10, 2024 that will close this issue
@alexr00 alexr00 added the feature-request Request for new features or functionality label Mar 11, 2024
@mohamedamara1
Copy link
Contributor Author

@alexr00 any infos on if we need this now? I opened a PR and want to keep working on it

@alexr00
Copy link
Member

alexr00 commented Mar 12, 2024

I am not aware of GitHub API that lets us do this, but if you've found GitHub API that lets you link an issue then that's great. I would accept a PR for it. I imagine that the feature would work like this:

  • There would be a new "Development" section in the sidebar
  • When you click on the gear or section title it would open a quick pick with issues
  • I don't know what the query for the issues should be. You would likely need to update the query based on what the user types

@mohamedamara1
Copy link
Contributor Author

Well, after researching, there is no API that links an issue to a PR or vice versa, yet.

But we can for now create the Development section and it will be read only, it will list the linked issues without allowing the user to make changes to it.

There's also the workaround of creating comments with a keyword like "fixes #" or "resolves #" etc.. to indirectly reference an issue, but I don't think this looks good when there are multiple issues to link.

This is how it looks like in the draft PR that I opened (it's WIP just wanted to see if I can get it to list the linked issues)

image

@alexr00
Copy link
Member

alexr00 commented Mar 12, 2024

Sounds good. We should not show the gear icon in the Linked Issues section though since it cannot be changed.

@mohamedamara1
Copy link
Contributor Author

Alright, I will create another issue for it then to mention that it will just display the linked issues and feel free to close this one if you'd like.

@alexr00
Copy link
Member

alexr00 commented Mar 12, 2024

It's fine to use this issue since we have had a discussion in it. I'll just rename the issue.

@alexr00 alexr00 changed the title Linking PR to issue(s) from the PR Overview Display linked issue(s) from the PR Overview Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants