Skip to content

Commit 8d44a84

Browse files
authored
simplify the bug report template (#63851)
* simplify the bug report template Changes involve: - Merging how to reproduce and what happened as these two pieces of information are naturally intertwined and a good reproduction walkthrough usually tells the story of what went wrong along the way. - apache airflow version is usually a handy information while filing the bug. Instead of giving dropdowns, the user let to mention the airflow version would cover redundant ask of filling the version if it belongs to 3x versions. * pre-commit fixes updating the missing line in the bug template fixing yaml linting issues * simplify the bug report template Changes involve: - Merging how to reproduce and what happened as these two pieces of information are naturally intertwined and a good reproduction walkthrough usually tells the story of what went wrong along the way. - apache airflow version is usually a handy information while filing the bug. Instead of giving dropdowns, the user let to mention the airflow version would cover redundant ask of filling the version if it belongs to 3x versions. * pre-commit fixes updating the missing line in the bug template fixing yaml linting issues * reverting linting changes unrelated to the template edit * add placeholder and update terminology * retain the airflow version type and structure Since the issue template is static in nature, hiding the other versions is not allowed. Retaining the current element type till the alternate options are decided * add placeholder text for airflow version input and update verbiage. - updated the airflow version field to have placeholder that hints the reporter run the airflow version command and paste the output. - minor verbiage update for issue description * remove quotes for the placeholder
1 parent ac9b401 commit 8d44a84

1 file changed

Lines changed: 19 additions & 38 deletions

File tree

.github/ISSUE_TEMPLATE/1-airflow_bug_report.yml

Lines changed: 19 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -25,40 +25,38 @@ body:
2525
[Security Reporting Guidelines](https://github.com/apache/airflow/blob/main/.github/SECURITY.md)
2626
instead.
2727
<br clear='left'/>"
28-
# yamllint enable rule:line-length
29-
- type: dropdown
28+
- type: input
3029
attributes:
3130
label: Apache Airflow version
3231
description: >
33-
Select your Airflow version.
32+
Enter your Airflow version.
3433
**Please note:** Airflow 2.x is in limited support (critical and security fixes only), and reaches
3534
EOL on April 22, 2026 - see the
3635
[Airflow 2 EOL page]
3736
(https://airflow.apache.org/docs/apache-airflow/stable/installation/supported-versions.html)
3837
for more information.
39-
multiple: false
40-
options:
41-
- "3.1.8"
42-
- "2.11.X"
43-
- "main (development)"
44-
- "Other Airflow 3 version (please specify below)"
38+
Remember, you are encouraged to test with the latest release or on the `main` branch to verify your issue still exists, especially if
39+
your version is at least a minor version older than the [current stable release](https://airflow.apache.org/docs/apache-airflow/stable/installation/supported-versions.html#version-life-cycle).
40+
# yamllint enable rule:line-length
41+
placeholder: Run `airflow version` and paste the output here
4542
validations:
4643
required: true
47-
- type: input
48-
attributes:
49-
label: If "Other Airflow 3 version" selected, which one?
50-
# yamllint disable rule:line-length
51-
description: >
52-
On what 3.X version of Airflow are you currently experiencing the issue? Remember, you are encouraged to
53-
test with the latest release or on the `main` branch to verify your issue still exists, especially if
54-
your version is at least a minor version older than the [current stable release](https://airflow.apache.org/docs/apache-airflow/stable/installation/supported-versions.html#version-life-cycle).
55-
# yamllint enable rule:line-length
5644
- type: textarea
5745
attributes:
58-
label: What happened?
59-
description: Describe what happened.
46+
label: What happened and how to reproduce it?
47+
description: >
48+
Describe what happened and please make sure you provide a
49+
reproducible step-by-step case of how to reproduce the problem as
50+
minimally and precisely as possible.
6051
placeholder: >
61-
Please provide the context in which the problem occurred and explain what happened
52+
Please provide the context in which the problem occurred and keep
53+
in mind we do not have access to your cluster or DAGs. Remember that
54+
non-reproducible issues will be closed! Opening a discussion is
55+
recommended as a first step. Feel free to use the following template:
56+
**Issue Description **
57+
< describe your issue >
58+
**Steps to reproduce:**
59+
< detailed steps to reproduce >
6260
validations:
6361
required: true
6462
- type: textarea
@@ -70,26 +68,11 @@ body:
7068
the fragment of logs showing the exact error messages or wrong behaviour and screenshots for
7169
UI problems or YouTube link to a video of you demonstrating the problem. You can include files by
7270
dragging and dropping them here.
73-
- type: textarea
74-
attributes:
75-
label: How to reproduce
76-
description: >
77-
What should we do to reproduce the problem? If you are not able to provide a reproducible case,
78-
please open a [discussion](https://github.com/apache/airflow/discussions) instead.
79-
placeholder: >
80-
Please make sure you provide a reproducible step-by-step case of how to reproduce the problem
81-
as minimally and precisely as possible. Keep in mind we do not have access to your cluster or DAGs.
82-
Remember that non-reproducible issues will be closed! Opening a discussion is recommended as a
83-
first step.
84-
validations:
85-
required: true
8671
- type: input
8772
attributes:
8873
label: Operating System
8974
description: What Operating System are you using?
9075
placeholder: "You can get it via `cat /etc/os-release` for example"
91-
validations:
92-
required: true
9376
- type: textarea
9477
attributes:
9578
label: Versions of Apache Airflow Providers
@@ -113,8 +96,6 @@ body:
11396
- "Amazon (AWS) MWAA"
11497
- "Microsoft ADF Managed Airflow"
11598
- "Other"
116-
validations:
117-
required: true
11899
- type: textarea
119100
attributes:
120101
label: Deployment details

0 commit comments

Comments
 (0)