Skip to content

Commit

Permalink
github: add template for dm and refine other templates (#3282)
Browse files Browse the repository at this point in the history
  • Loading branch information
Rustin170506 authored Nov 5, 2021
1 parent 2a60472 commit df6eefc
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 6 deletions.
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/dm-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: "\U0001F41B DM Bug Report"
description: Something isn't working as expected
labels: ["type/bug","area/dm"]
body:
- type: markdown
attributes:
value: |
Please answer these questions before submitting your issue. Thanks!
- type: textarea
id: problem
attributes:
label: What did you do?
description: If possible, provide a recipe for reproducing the error.
validations:
required: true
- type: textarea
id: expect
attributes:
label: What did you expect to see?
validations:
required: false
- type: textarea
id: see
attributes:
label: What did you see instead?
validations:
required: false
- type: textarea
id: version
attributes:
label: Versions of the cluster
value: |-
DM version (run `dmctl -V` or `dm-worker -V` or `dm-master -V`):
```console
(paste DM version here, and you must ensure versions of dmctl, DM-worker and DM-master are same)
```
Upstream MySQL/MariaDB server version:
```console
(paste upstream MySQL/MariaDB server version here)
```
Downstream TiDB cluster version (execute `SELECT tidb_version();` in a MySQL client):
```console
(paste TiDB cluster version here)
```
How did you deploy DM: tiup or manually?
```console
(leave TiUP or manually here)
```
Other interesting information (system version, hardware config, etc):
```console
>
>
```
validations:
required: true
- type: textarea
id: current
attributes:
label: current status of DM cluster (execute `query-status <task-name>` in dmctl)
value: |-
```console
(paste current status of DM cluster here)
```
validations:
required: false
- type: markdown
attributes:
value: |
Operation logs
- Please upload `dm-worker.log` for every DM-worker instance if possible
- Please upload `dm-master.log` if possible
- Other interesting logs
- Output of dmctl's commands with problems
- type: markdown
attributes:
value: |
Configuration of the cluster and the task
- `dm-worker.toml` for every DM-worker instance if possible
- `dm-master.toml` for DM-master if possible
- task config, like `task.yaml` if possible
- type: markdown
attributes:
value: |
Screenshot/exported-PDF of Grafana dashboard or metrics' graph in Prometheus for DM if possible
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/flaking-test.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: "\U0001F608 Flaking Test"
description: Report flaky tests or jobs in TiCDC CI
description: Report flaky tests or jobs
labels: ["component/test"]
body:
- type: markdown
attributes:
value: |
Please only use this template for submitting reports about flaky tests or jobs (pass or fail with no underlying change in code) in TiCDC CI.
Please only use this template for submitting reports about flaky tests or jobs (pass or fail with no underlying change in code) in DM/TiCDC CI.
Please link this report to https://github.com/pingcap/ticdc/issues/2246 as a subtask.
- type: textarea
id: jobs
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ body:
required: true
- label: Searched open and closed [GitHub issues](https://github.com/pingcap/ticdc/issues?q=is%3Aissue)
required: true
- label: Read the [documentation](https://docs.pingcap.com/tidb/stable/ticdc-overview)
- label: Read the [documentation](https://docs.pingcap.com/tidb/stable)
required: true
- type: textarea
id: question
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: "\U0001F41B Bug Report"
description: File a bug report
labels: ["type/bug"]
name: "\U0001F41B TiCDC Bug Report"
description: Something isn't working as expected
labels: ["type/bug","area/ticdc"]
body:
- type: markdown
attributes:
Expand Down

0 comments on commit df6eefc

Please sign in to comment.