Skip to content

Commit b9fec9b

Browse files
Merge pull request #2672 from buildkite/pie-2212-add-page-about-assignment-to-docs-before-ga
[PIE-2212] Add docs for team assignment and badges
2 parents fc11f80 + 8141b87 commit b9fec9b

File tree

7 files changed

+34
-0
lines changed

7 files changed

+34
-0
lines changed

data/nav.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,8 @@
382382
path: "test-analytics/test-executions"
383383
- name: "Public test suites"
384384
path: "test-analytics/public-test-suites"
385+
- name: "Flaky test assignment"
386+
path: "test-analytics/flaky-test-assignment"
385387
- name: "Languages"
386388
start_expanded: true
387389
children:
135 KB
Loading
365 KB
Loading
226 KB
Loading
240 KB
Loading
194 KB
Loading
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Flaky test assignment
2+
3+
Customers on the [Pro and Enterprise plans](https://buildkite.com/pricing) can assign flaky tests to [Teams](/docs/team-management/permissions).
4+
5+
## Enabling flaky test assignments
6+
7+
To enable assignments, you must have at least one team that has access to your suite. You may need to ask your admin to enable the teams feature, and then create teams via the organization settings page.
8+
9+
<%= image "flaky-test-no-teams.png", width: 1960/2, height: 630/2, alt: "Flaky test page showing dropdown menu prompting user to create teams" %>
10+
<%= image "team-settings.png", width: 1960/2, height: 630/2, alt: "Team page for assigning test suites" %>
11+
12+
## Assigning a test
13+
14+
When viewing your flaky tests, you should now see a list of teams with suite access permissions listed inside the assignment dropdown. From here you may assign, reassign or remove the assignment.
15+
16+
>🚧 Assignment permissions
17+
> All team members have the ability to create, update or remove an assignment. This feature is not restricted to admins.
18+
19+
Tests that are assigned to a team will be updated to display a badge indicating as such. This badge is also visible on issues in the run page.
20+
21+
<%= image "flaky-test-teams.png", width: 1960/2, height: 630/2, alt: "Flaky test page showing team assignments" %>
22+
23+
## Viewing assignments
24+
25+
Users can check their test assignments by clicking _My Assignments_ in the side bar.
26+
27+
<%= image "recent-assignments.png", width: 1960/2, height: 630/2, alt: "Flaky test page showing team assignments" %>
28+
29+
When an assigned test has not flaked in more than 7 days, it is moved to the _Outdated flaky tests_ section. An assignment could become out of date due to a flaky test being fixed, or perhaps it belongs to a pipeline which has not had a build in the last 7 days. Should the flake reoccur, the assignment will be moved back to the _Recent flaky tests_ page.
30+
31+
<%= image "outdated-assignments.png", width: 1960/2, height: 630/2, alt: "Flaky test page showing team assignments" %>
32+

0 commit comments

Comments
 (0)