Skip to content

Commit c2acbd0

Browse files
am-steadheiskr
andauthored
Dependencies (for Issues and Projects) #16501 (#56296)
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
1 parent 7d8b9cf commit c2acbd0

File tree

6 files changed

+50
-2
lines changed

6 files changed

+50
-2
lines changed

content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ You can use {% data variables.product.prodname_projects_v2 %} to manage your wor
2121

2222
Breaking a large issue into smaller issues makes the work more manageable and enables team members to work in parallel. It also leads to smaller pull requests, which are easier to review.
2323

24-
To track how smaller issues fit into the larger goal, milestones, or labels. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels).
24+
To ensure efficient progress, clearly define which issues are blocked by, or blocking, other issues. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies).
25+
26+
To track how smaller issues fit into the larger goal, use milestones or labels. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels).
2527

2628
## Communicate
2729

content/issues/tracking-your-work-with-issues/about-issues.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Issues can be created in a variety of ways, so you can choose the most convenien
3535

3636
{% endif %}
3737

38+
## About issue dependencies
39+
40+
You can define blocking relationships between issues using issue dependencies. Issue dependencies let you identify issues that are blocked by, or blocking, other work. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies).
41+
3842
## About integration with {% data variables.product.github %}
3943

4044
Issues integrate with your work all across {% data variables.product.github %}. Mentioning an issue in another issue or pull request will create references between them and using keywords, like `fixes:`, in your pull requests will automatically close the associated issues. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue).

content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ Below we have added a task list to our Project Octocat issue, breaking it down i
9292

9393
{% endif %}
9494

95+
### Showing which issues are blocked by, or blocking, other work
96+
97+
By creating issue dependencies, you can easily see and communicate which issues are blocked by, or blocking, other issues. This helps streamline coordination, prevent bottlenecks and increase transparency across the team. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies).
98+
9599
{% ifversion copilot %}
96100

97101
## Understanding new issues
@@ -175,7 +179,7 @@ You can also use the existing {% data variables.product.prodname_projects_v1 %}
175179

176180
Below is a {% data variables.projects.projects_v1_board %} for our example Project Octocat with the issue we created, and the smaller issues we broke it down into, added to it.
177181

178-
![Screenshot of a {% data variables.projects.projects_v1_board %} called "Project Octocat Board," with issues organized into columns for "To do", "In progress," and "Done."](/assets/images/help/issues/quickstart-project-board.png)
182+
![Screenshot of a {% data variables.projects.projects_v1_board %} called "Project Octocat Board," with issues organized into columns for "To do," "In progress," and "Done."](/assets/images/help/issues/quickstart-project-board.png)
179183

180184
{% endif %}
181185

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Creating issue dependencies
3+
intro: 'Learn how to create issue dependencies so that you can see which issues are blocked by, or blocking, other work.'
4+
versions:
5+
fpt: '*'
6+
ghec: '*'
7+
type: overview
8+
topics:
9+
- Project management
10+
permissions: 'People with at least triage permissions for a repository can create issue dependencies.'
11+
product: 'Issue dependencies are available for users on {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %} plans.'
12+
---
13+
14+
{% data reusables.issues.issue-dependencies-preview-note %}
15+
16+
Issue dependencies let you define issues that are blocked by, or blocking, other work.
17+
18+
## Marking an issue as blocked by, or blocking, another issue
19+
20+
1. Navigate to the issue that you want to create a dependency for.
21+
1. In the right sidebar, click **Relationships**.
22+
1. From the dropdown, select a dependency option:
23+
* To indicate that your issue depends on another issue being completed, select **Mark as blocked by**.
24+
* To indicate that your issue is preventing another issue from being completed, select **Mark as blocking**.
25+
1. In the dialog box that opens, search for and select all the issues that are blocked by, or blocking, your issue.
26+
27+
Blocked issues are marked with a "Blocked" icon on your project boards or repository's Issues page, so you can easily identify bottlenecks.
28+
29+
## Removing a blocking relationship between two issues
30+
31+
1. Navigate to the issue that you want to remove a dependency from.
32+
1. In the right sidebar, click **Relationships**.
33+
1. From the dropdown, select a dependency option:
34+
* To indicate that your issue no longer depends on another issue being completed, select **Change blocked by**.
35+
* To indicate that your issue is no longer preventing another issue from being completed, select **Change blocking**.
36+
1. In the dialog box that opens, deselect the issues that are no longer blocked by, or blocking, your issue.

content/issues/tracking-your-work-with-issues/using-issues/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ topics:
1010
children:
1111
- /creating-an-issue
1212
- /adding-sub-issues
13+
- /creating-issue-dependencies
1314
- /assigning-issues-and-pull-requests-to-other-github-users
1415
- /editing-an-issue
1516
- /viewing-all-of-your-issues-and-pull-requests
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
> [!NOTE] Issue dependencies are in public preview and subject to change.

0 commit comments

Comments
 (0)