From 5572c27bc080abe65138e7e8a8f49da851f790c8 Mon Sep 17 00:00:00 2001
From: Maria Grimaldi <maria.grimaldi@edunext.co>
Date: Thu, 1 Jun 2023 13:24:19 -0400
Subject: [PATCH] feat: add new template for reporting test failures (#281)

---
 .github/ISSUE_TEMPLATE/test-failures.yml      | 50 +++++++++++++++++++
 .../workflows/add-label-on-failure-report.yml | 16 ++++++
 2 files changed, 66 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/test-failures.yml
 create mode 100644 .github/workflows/add-label-on-failure-report.yml

diff --git a/.github/ISSUE_TEMPLATE/test-failures.yml b/.github/ISSUE_TEMPLATE/test-failures.yml
new file mode 100644
index 0000000..a3fef6a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/test-failures.yml
@@ -0,0 +1,50 @@
+name: 📑 Test failure report
+description: Issue Template for Reporting Testing Failures.
+title: "[Test failure] <Test Case ID>: <DESCRIPTIVE TITLE>"
+labels: ["needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Test failure report
+        Describe the failure you encountered while testing a release.
+  - type: input
+    id: release
+    attributes:
+      label: Release
+      description: Include the name of the release in which the testing was performed.
+      placeholder: Ironwood
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: Describe what was expected to happen during testing.
+      placeholder:
+    validations:
+      required: true
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual behavior
+      description: Describe what actually happened during testing, including any errors or failures encountered.
+      placeholder:
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Provide detailed steps to reproduce the testing failure.
+      placeholder:
+    validations:
+      required: true
+  - type: textarea
+    id: more-info
+    attributes:
+      label: Additional information
+      description: Include any additional information that may be helpful in understanding the testing failure, such as screenshots or log files.
+  - type: markdown
+    attributes:
+      value: "The BTR team will review this issue as soon as possible. In the meantime, help us categorize this issue by adding the appropriate labels!"
diff --git a/.github/workflows/add-label-on-failure-report.yml b/.github/workflows/add-label-on-failure-report.yml
new file mode 100644
index 0000000..fb62382
--- /dev/null
+++ b/.github/workflows/add-label-on-failure-report.yml
@@ -0,0 +1,16 @@
+
+name: Allows for the adding labels when opening a test failure issue.
+
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  add_label:
+    runs-on: ubuntu-latest
+    if: ${{ contains(github.event.issue.title, 'Test failure') && !contains(github.event.issue.labels.*.name, 'needs triage') }}
+    steps:
+      - name: apply needs triage label
+        uses: actions-ecosystem/action-add-labels@v1
+        with:
+          labels: needs triage