From 0987c37313830d21eecc93cdb424785854ecf4d5 Mon Sep 17 00:00:00 2001 From: FangYin Cheng Date: Wed, 6 Sep 2023 08:57:39 +0800 Subject: [PATCH 1/2] feat(CI): new issue template and release drafter --- .github/ISSUE_TEMPLATE/bug-report.yml | 184 ++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 38 ---- .../ISSUE_TEMPLATE/documentation-related.md | 10 - .../ISSUE_TEMPLATE/documentation-related.yml | 40 ++++ .github/ISSUE_TEMPLATE/feature-request.yml | 57 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 -- .github/release-drafter.yml | 106 ++++++++++ pilot/server/knowledge/_cli/knowledge_cli.py | 1 + pilot/utils/parameter_utils.py | 2 +- 9 files changed, 389 insertions(+), 69 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/documentation-related.md create mode 100644 .github/ISSUE_TEMPLATE/documentation-related.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/release-drafter.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..8437e773e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,184 @@ +name: Bug report +title: "[Bug] [Module Name] Bug title " +description: Create a report to help us improve +labels: [ "bug", "Waiting for reply" ] +body: + - type: markdown + attributes: + value: > + Thank you for taking the time to report a bug. + + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/eosphoros-ai/DB-GPT/issues?q=is%3Aissue) + first to see whether the same issue was reported already. + options: + - label: > + I had searched in the [issues](https://github.com/eosphoros-ai/DB-GPT/issues?q=is%3Aissue) and found + no similar issues. + required: true + + - type: dropdown + id: system-information + attributes: + label: Operating system information + description: Operating system you use + options: + - Linux + - Windows + - MacOS(x86) + - MacOS(M1, M2...) + - Other + validations: + required: true + + - type: dropdown + id: python-version + attributes: + label: Python version information + description: Python version you use + options: + - ">=3.11" + - "3.10" + - "3.9" + - "<3.9" + validations: + required: true + + - type: dropdown + id: code-version + attributes: + label: DB-GPT version + description: > + Which version of DB-GPT are you running? + options: + - main + - latest release + - v0.3.7 + - + [Installation From Source](https://db-gpt.readthedocs.io/en/latest/getting_started/install/deploy/deploy.html) + - label: > + [Docker Installation](https://db-gpt.readthedocs.io/en/latest/getting_started/install/docker/docker.html) + - label: > + [Docker Compose Installation](https://db-gpt.readthedocs.io/en/latest/getting_started/install/docker/docker.html) + - label: > + [Cluster Installation](https://db-gpt.readthedocs.io/en/latest/getting_started/install/llm/cluster/model_cluster.html) + - label: AutoDL Image + - label: Other + + - type: textarea + id: device-information + attributes: + label: Device information + description: Describe the device you use + placeholder: > + Device: CPU or GPU + + If using GPU: + + - GPU Count: 1 + + - GPU Memory: 24G + validations: + required: true + + - type: textarea + id: models-information + attributes: + label: Models information + description: Describe the LLM and embedding model you use + placeholder: > + LLM: vicuna-13b-v1.5 + + Embedding model: text2vec-large-chinese + validations: + required: true + + - type: textarea + attributes: + label: What happened + description: Describe the bug + placeholder: > + A clear and concise description of what the bug is. + validations: + required: true + + - type: textarea + attributes: + label: What you expected to happen + description: What do you think went wrong? + placeholder: > + Thank you for your feedback! To better understand the issue: + + 1. Please describe why you believe the behavior is incorrect. + + 2. Share the relevant log segments or error messages. For UI issues, screenshots are appreciated. + + 3. For textual data, kindly copy and paste rather than using screenshots to facilitate easier searches in the future. + validations: + required: true + + - type: textarea + attributes: + label: How to reproduce + description: > + What should we do to reproduce the problem? If you are not able to provide a reproducible case, + please open a [Discussion](https://github.com/orgs/eosphoros-ai/discussions) instead. + placeholder: > + Steps to reproduce the behavior: + + 1. Go to '...' + + 2. Click on '....' + + 3. Scroll down to '....' + + 4. See error + validations: + required: true + + - type: textarea + attributes: + label: Additional context + description: Any other context about the problem here? + placeholder: > + Add any other context about the problem here. + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + It's completely optional, but if you're interested in contributing, we're here to help! + If you have insights on the solution, that's even better. DB-GPT thrives on community support, + and we warmly welcome new contributors. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for completing our form!" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a2998b85e..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]: " -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation-related.md b/.github/ISSUE_TEMPLATE/documentation-related.md deleted file mode 100644 index 5506434f7..000000000 --- a/.github/ISSUE_TEMPLATE/documentation-related.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Documentation Related -about: Describe this issue template's purpose here. -title: "[Doc]: " -labels: '' -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/documentation-related.yml b/.github/ISSUE_TEMPLATE/documentation-related.yml new file mode 100644 index 000000000..1f7ceb778 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-related.yml @@ -0,0 +1,40 @@ +name: Documentation Related +description: Suggest an improvement or report a bug for this project's Documentation +title: "[Doc][Module Name] Documentation bug or improvement" +labels: [ "documentation", "Waiting for reply" ] +body: + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/eosphoros-ai/DB-GPT/issues?q=is%3Aissue) first + to see whether the same feature was requested already. + options: + - label: > + I had searched in the [issues](https://github.com/eosphoros-ai/DB-GPT/issues?q=is%3Aissue) and found no + similar feature requirement. + required: true + + - type: textarea + attributes: + label: Description + description: A short description why your find in our document. + + - type: textarea + attributes: + label: Documentation Links + description: Copy and paste one or more links of this documentation issue. + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + It's completely optional, but if you're interested in contributing, we're here to help! + If you have insights on the solution, that's even better. DB-GPT thrives on community support, + and we warmly welcome new contributors. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for completing our form!" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..9495737e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,57 @@ +name: Feature request +description: Suggest an idea for this project +title: "[Feature][Module Name] Feature title" +labels: [ "enhancement", "Waiting for reply" ] +body: + - type: checkboxes + attributes: + label: Search before asking + description: > + Please make sure to search in the [issues](https://github.com/eosphoros-ai/DB-GPT/issues?q=is%3Aissue) first + to see whether the same feature was requested already. + options: + - label: > + I had searched in the [issues](https://github.com/eosphoros-ai/DB-GPT/issues?q=is%3Aissue) and found no + similar feature requirement. + required: true + + - type: textarea + attributes: + label: Description + description: A short description of your feature + + - type: textarea + attributes: + label: Use case + description: What do you want to happen? + placeholder: > + Instead of detailing how to implement the feature, please describe your end goal or what you aim to achieve. + + - type: textarea + attributes: + label: Related issues + description: Is there currently another issue associated with this? + + - type: dropdown + id: priority + attributes: + label: Feature Priority + description: How would you rank the importance of this feature? + options: + - High + - Medium + - Low + + - type: checkboxes + attributes: + label: Are you willing to submit PR? + description: > + It's completely optional, but if you're interested in contributing, we're here to help! + If you have insights on the solution, that's even better. DB-GPT thrives on community support, + and we warmly welcome new contributors. + options: + - label: Yes I am willing to submit a PR! + + - type: markdown + attributes: + value: "Thanks for completing our form!" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 0ccd363af..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[Feature]:" -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 000000000..9ec432bc7 --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,106 @@ +categories: + - title: 🏆 Highlights + labels: highlight + - title: 🚀 Performance improvements + labels: performance + - title: ✨ Enhancements + labels: enhancement + - title: 🐞 Bug fixes + labels: fix + - title: ⚠️ Deprecations + labels: deprecation + - title: 🛠️ Other improvements + labels: + - documentation + - build + - internal + +change-template: '- $TITLE (#$NUMBER)' +change-title-escapes: '\<*_&' +replacers: + # Remove conventional commits from titles + - search: '/- (build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)(\(.*\))?(\!)?\: /g' + replace: '- ' + +autolabeler: + - label: model + title: + # feat(mode): Support llama-2 + # fix(mode): Fix llama-2 xxx bug + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*model.*\)/' + - label: ChatData + title: + # feat(ChatData): Support xxxx + # fix(ChatData): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*ChatData.*\)/' + - label: ChatExcel + title: + # feat(ChatExcel): Support xxxx + # fix(ChatExcel): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*ChatExcel.*\)/' + - label: ChatDB + title: + # feat(ChatDB): Support xxxx + # fix(ChatDB): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*ChatDB.*\)/' + - label: ChatKnowledge + title: + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*ChatKnowledge.*\)/' + - label: ChatDashboard + title: + # feat(ChatDashboard): Support xxxx + # fix(ChatDashboard): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*ChatDashboard.*\)/' + - label: plugin + title: + # feat(plugin): Support xxxx + # fix(plugin): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*plugin.*\)/' + - label: agent + title: + # feat(agent): Support xxxx + # fix(agent): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*agent.*\)/' + - label: cli + title: + # feat(cli): Support xxxx + # fix(cli): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*cli.*\)/' + - label: prompt + title: + # feat(prompt): Support xxxx + # fix(prompt): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*prompt.*\)/' + - label: connection + title: + # feat(connection): Support xxxx + # fix(connection): Fix xxx + - '/^(build|chore|ci|depr|docs|feat|fix|perf|refactor|release|test)\(.*connection.*\)/' + - label: build + title: + - '/^build/' + - label: documentation + title: + - '/^docs/' + - label: enhancement + title: + - '/^feat/' + - label: fix + title: + - '/^fix/' + - label: performance + title: + - '/^perf/' + - label: release + title: + - '/^release/' + + - label: internal + title: + - '/^(chore|ci|refactor|test)/' + +template: | + $CHANGES + + Thank you to all our contributors for making this release possible! + $CONTRIBUTORS \ No newline at end of file diff --git a/pilot/server/knowledge/_cli/knowledge_cli.py b/pilot/server/knowledge/_cli/knowledge_cli.py index c8733c058..e970ec1e6 100644 --- a/pilot/server/knowledge/_cli/knowledge_cli.py +++ b/pilot/server/knowledge/_cli/knowledge_cli.py @@ -53,6 +53,7 @@ def knowledge_cli_group(address: str): required=False, type=bool, default=False, + is_flag=True, show_default=True, help="Skip wrong document", ) diff --git a/pilot/utils/parameter_utils.py b/pilot/utils/parameter_utils.py index a584a4e69..247cfb43d 100644 --- a/pilot/utils/parameter_utils.py +++ b/pilot/utils/parameter_utils.py @@ -165,7 +165,7 @@ class EnvArgumentParser: if not env_var_value: env_var_value = kwargs.get(field.name) - print(f"env_var_value: {env_var_value} for {field.name}") + # print(f"env_var_value: {env_var_value} for {field.name}") # Add a command-line argument for this field EnvArgumentParser._build_single_argparse_option( parser, field, env_var_value From 50e0a0afd5c1e33ad7d06154e550874ff85ea4b8 Mon Sep 17 00:00:00 2001 From: FangYin Cheng Date: Wed, 6 Sep 2023 09:28:53 +0800 Subject: [PATCH 2/2] feat(CI): add module name link --- .github/ISSUE_TEMPLATE/bug-report.yml | 4 +++- .github/ISSUE_TEMPLATE/documentation-related.yml | 7 +++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 7 +++++++ 3 files changed, 17 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 8437e773e..17ebbefbb 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -6,7 +6,9 @@ body: - type: markdown attributes: value: > - Thank you for taking the time to report a bug. + Thank you for taking the time to report a bug. The `[Module Name]` in title see + [here](https://github.com/eosphoros-ai/DB-GPT/labels?q=Module), + if you don't know the module name, you don't have to fill it in. - type: checkboxes attributes: diff --git a/.github/ISSUE_TEMPLATE/documentation-related.yml b/.github/ISSUE_TEMPLATE/documentation-related.yml index 1f7ceb778..8d83f2623 100644 --- a/.github/ISSUE_TEMPLATE/documentation-related.yml +++ b/.github/ISSUE_TEMPLATE/documentation-related.yml @@ -3,6 +3,13 @@ description: Suggest an improvement or report a bug for this project's Documenta title: "[Doc][Module Name] Documentation bug or improvement" labels: [ "documentation", "Waiting for reply" ] body: + - type: markdown + attributes: + value: > + Thank you for taking the time to suggest an improvement or report a bug for this project's documentation. + The `[Module Name]` in title see [here](https://github.com/eosphoros-ai/DB-GPT/labels?q=Module), + if you don't know the module name, you don't have to fill it in. + - type: checkboxes attributes: label: Search before asking diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 9495737e1..d611b7da3 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -3,6 +3,13 @@ description: Suggest an idea for this project title: "[Feature][Module Name] Feature title" labels: [ "enhancement", "Waiting for reply" ] body: + - type: markdown + attributes: + value: > + Thank you for taking the time to suggest an idea for this project. + The `[Module Name]` in title see [here](https://github.com/eosphoros-ai/DB-GPT/labels?q=Module), + if you don't know the module name, you don't have to fill it in. + - type: checkboxes attributes: label: Search before asking