diff --git a/.gitbook/assets/app.trunk-staging.io_totally-real-saas_flaky-tests_test_fa45dbe2-afe2-5314-880e-e4a03175a323_repo=gewenyu99%2Freal-saas-app.png b/.gitbook/assets/app.trunk-staging.io_totally-real-saas_flaky-tests_test_fa45dbe2-afe2-5314-880e-e4a03175a323_repo=gewenyu99%2Freal-saas-app.png new file mode 100644 index 00000000..e4476b9b Binary files /dev/null and b/.gitbook/assets/app.trunk-staging.io_totally-real-saas_flaky-tests_test_fa45dbe2-afe2-5314-880e-e4a03175a323_repo=gewenyu99%2Freal-saas-app.png differ diff --git a/.gitbook/assets/connect-jira.png b/.gitbook/assets/connect-jira.png new file mode 100644 index 00000000..da24f4ea Binary files /dev/null and b/.gitbook/assets/connect-jira.png differ diff --git a/.gitbook/assets/create-ticket-button.png b/.gitbook/assets/create-ticket-button.png new file mode 100644 index 00000000..79ee50ab Binary files /dev/null and b/.gitbook/assets/create-ticket-button.png differ diff --git a/.gitbook/assets/create-ticket-kebab.png b/.gitbook/assets/create-ticket-kebab.png new file mode 100644 index 00000000..5f0d7f6f Binary files /dev/null and b/.gitbook/assets/create-ticket-kebab.png differ diff --git a/.gitbook/assets/example-jira-form.png b/.gitbook/assets/example-jira-form.png new file mode 100644 index 00000000..a6ede5fb Binary files /dev/null and b/.gitbook/assets/example-jira-form.png differ diff --git a/.gitbook/assets/example-jira-ticket (1) (1).png b/.gitbook/assets/example-jira-ticket (1) (1).png new file mode 100644 index 00000000..78fb6e7c Binary files /dev/null and b/.gitbook/assets/example-jira-ticket (1) (1).png differ diff --git a/.gitbook/assets/example-jira-ticket (1).png b/.gitbook/assets/example-jira-ticket (1).png new file mode 100644 index 00000000..78fb6e7c Binary files /dev/null and b/.gitbook/assets/example-jira-ticket (1).png differ diff --git a/.gitbook/assets/example-jira-ticket.png b/.gitbook/assets/example-jira-ticket.png new file mode 100644 index 00000000..538dbaf4 Binary files /dev/null and b/.gitbook/assets/example-jira-ticket.png differ diff --git a/flaky-tests/create-a-new-ticket.md b/flaky-tests/create-a-new-ticket.md new file mode 100644 index 00000000..76868d31 --- /dev/null +++ b/flaky-tests/create-a-new-ticket.md @@ -0,0 +1,51 @@ +# Create a New Ticket + +When Trunk Flaky Tests detects a broken or flaky test, you can create an automatically generated ticket for your team to pick up and fix the test. Currently, Ticket Creation only supports integrations with Jira, but the automatically generated ticket content is formatted in Markdown and can be copied to other platforms like Asana, Linear, or GitHub issues. + +### Connecting to Jira + +
+ +To connect a Jira Cloud project, navigate to Settings > Repositories > Jira Cloud. Then complete the form and click Connect to Jira Cloud with the following information. + +
Field NameDescriptionExamples
Jira URLThe URL to your Jira Cloud project.https://trunk-io.atlassian.net
Project KeyThe project key for your Jira project.KAN
EmailThe email associated with your Jira API token.johndoe@example.com
Jira API tokenCreate your Jira API token here.ATATT*****19FNY5Q
Default label(s) for new ticketsLabels applied to new Jira tickets created through Trunk Flaky Testsflaky-test, debt
+ +After connecting to Jira, you can specify a default issue type for new tickets and a default assignee for the new tickets. + +### Ticket Content + +Trunk Flaky Tests automatically generates tickets complete with a title and description. If you’re connected to a project management software like Jira, there are further options to assign default labels or assignees. + +The ticket description contains the following information: + +* Identifier of the test +* Since when the test has been labeled flaky +* The last time this test has failed +* The impact when run on PRs +* The impact when run on branches +* Quarantine status +* Most common failure reasons + +### Create a New Ticket + +You can create a new ticket for any test listed in Trunk Flaky Tests. + +You can create a new ticket on the Flaky Test dashboard by clicking on the options menu for any test cases listed. + +
+ +You can also find a Create Ticket button in the top left corner of the test case details screen as well. + +
+ +Before you create the ticket, you will have a preview of the title and description of the ticket. + +
+ +#### Create with Jira + +If you are connected to Jira, you can click the **Create Jira Ticket** button at the end of the modal, which will automatically create a ticket with the configured labels and assignees. + +#### Create Manually + +If you have not set up an integration, Trunk Flaky Tests will still generate a ticket title and description so you can copy and paste the details into your project management software. diff --git a/summary.md b/summary.md index 622585b8..92a8e3d4 100644 --- a/summary.md +++ b/summary.md @@ -1,4 +1,4 @@ -# Table of Contents +# Table of contents * [Welcome](welcome.md) * [Code Quality](code-quality/README.md) @@ -188,6 +188,7 @@ * [unittest](flaky-tests/frameworks/unittest.md) * [Vitest](flaky-tests/frameworks/vitest.md) * [XCTest](flaky-tests/frameworks/xctest.md) + * [Create a New Ticket](flaky-tests/create-a-new-ticket.md) * [Uploader](flaky-tests/uploader.md) * [Quarantining](flaky-tests/quarantining.md) * [PR Test Summary](flaky-tests/github-pull-request-comments.md) @@ -244,8 +245,10 @@ * [Integration for Slack](administration/integration-for-slack.md) * [GitHub App Permissions](administration/github-app-permissions.md) * [Manage Members & Organizations](administration/manage-members-and-organizations.md) + ## Links + * [Open App](https://app.trunk.io) * [Slack Community](https://slack.trunk.io) * [Changelog](https://trunk.io/changelog) -* [Feature Requests](https://features.trunk.io) \ No newline at end of file +* [Feature Requests](https://features.trunk.io)