Feature improvement - Pull request and issues linking

We already told you how great auto-linking was in this previous article.

Well, you asked for it, we did it ! We are excited to announce that major improvements have been made on this feature along with our new December feature release, the Team Board.

What's auto-linking for?

Pull request and issues linking is quite an essential concept in Keypup because it allows for two things:

  • Pull requests and related issues are automatically grouped in your Priority Inbox or the Team Board. This considerably reduces the number of items to deal with on a daily basis and makes for a clean, easy and direct reading of everything a Pull Request addresses (including all nested issues). More convenient than having to conduct speleological searches in your repo, no?
  • Pull request due dates are automatically inferred based on the due dates of related issues. This means Keypup can properly prioritize pull requests to the right person when moved to review or merge status.

How to link pull requests to issues then?

Linking from the Priority Inbox

It is possible to link pull requests to issues and issues to pull requests by clicking on the link icon 🔗 at the top right of each item. Doing so will display a search bar allowing you to search for the item to link.

Upon hitting save the linked pull request description will be modified and an auto-closing keyword will be added automatically.

Linking from GitHub and GitLab

Issues can be related to pull requests by using keywords in titles, descriptions and commits.

Via pull request title

Use a reference to the issue related to the PR:

  • The issue is in the same project as the PR: #9 My PR title
  • The issue is in a different project: KeypDemoCorp/awesome-ui#9 My PR title
  • The issue is in JIRA: [PROJ-123] My PR title
  • The issue is in Clickup: [#3yd0a3] My PR title

Multiple issues can be specified in the title.

Via pull request description

Use an auto-closing keyword (e.g. closes, fixes) followed by a reference to the issue.

This is my PR description.

# Via URL
closes: https://github.com/KeypDemoCorp/awesome-ui/issues/9

# Via ID if the issue is in the same project as the PR
closes: #9

# Via reference if the issue is in a different project
closes: KeypDemoCorp/awesome-ui#9

Multiple issues be closed via description. Each issue must be on a separate line with a closing keyword.

closes #9
closes PROJ-123

Via commit message

Use an auto-closing keyword (e.g. closes, fixes) followed by a reference to the issue in your commit title or message.

# Via reference if the issue is in a different project
KeypDemoCorp/awesome-ui#9 My commit title

- Decrease popover delays on dashboard components

# Via reference using auto linking keywords
closes: KeypDemoCorp/awesome-ui#9

# Via ID if the issue is in the same project as the PR
closes: #9

# Via URL
closes: https://github.com/KeypDemoCorp/awesome-ui/issues/9


Caveat with GitHub "Linked issues" feature

Please do not link issues to pull request via the Linked issues settings menu on the side of the pull request screen.

Issues linked this way are not exposed on the GitHub API unfortunately. This means any third-party application will be unable to see these links, including Keypup.

Use closing keywords instead, as described in the previous sections. Issues linked via closing keywords will still appear under the Linked issues setting menu don't worry.

Let us know what you think about this new feature!

If you are not a Keypup member yet, jump right in, it's free!

You may also like reading: