Skip to main content

Link a pull request to a project

Link your pull request to a Grove project, so your product lead sees the work, and Grove can check it when it merges.

Written by Jack Meyers

Link each pull request to the project it's for. Your product lead then sees it on the project's Delivery tab, and Grove checks the code against the project's outcomes when it merges.

Linking needs the Grove GitHub app connected to your workspace. A workspace admin connects it.

Three ways to link

Use any of them. You can use more than one.

Where

How

Example

Branch name or PR title

Put the project ID anywhere in it.

p-003-move-a-visit

PR description

Write a link word right before the project ID.

Part of P-003

Claims block

Add a project: line.

When your agent runs grove, or picks up a project, Grove prints these options for you.

Link words in the description

These words link a pull request when they come right before the project ID:

  • Part of

  • For

  • Contributes to

  • Toward or Towards

Case doesn't matter. A colon after the word is fine, such as Part of: P-003. One link word can list several projects, such as Part of P-003, P-004 and P-007.

What doesn't link

  • Other words, such as Fixes P-003, Closes P-003, Resolves P-003, or See P-003.

  • A project ID on its own in the description text.

  • A project ID inside code formatting, between backticks.

More than one project

A pull request can link to several projects. Use any of the three ways for each one.

Change the link later

Edit the branch name, title, or description. Grove checks the links again the next time the pull request changes.

If Grove didn't link it

Paste Part of P-003, with the right project ID, into the pull request's description.

Related articles

Did this answer your question?