github/DB-GPT
1
0
Fork 0
mirror of https://github.com/csunny/DB-GPT.git synced 2025-08-10 20:52:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(CI): new issue template and release drafter (#549)

Browse Source 
Close #548
This commit is contained in:
Aries-ckt 2023-09-06 09:48:31 +08:00 committed by GitHub
commit f6b4d0e3b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 405 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

186
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@ -0,0 +1,186 @@
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. 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
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
- <v0.3.7
validations:
required: true
- type: checkboxes
id: related-scenes
attributes:
label: Related scenes
description: Select the scenes related to the issue (if applicable)
options:
- label: Chat Data
- label: Chat Excel
- label: Chat DB
- label: Chat Knowledge
- label: Dashboard
- label: Plugins
- type: checkboxes
id: installation-information
attributes:
label: Installation Information
description: Select your installation method
options:
- label: >
[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!"

38
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -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.

10
.github/ISSUE_TEMPLATE/documentation-related.md vendored
View File

@ -1,10 +0,0 @@
---
name: Documentation Related
about: Describe this issue template's purpose here.
title: "[Doc]: "
labels: ''
assignees: ''
---

47
.github/ISSUE_TEMPLATE/documentation-related.yml vendored Normal file
View File

@ -0,0 +1,47 @@
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: 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
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!"

64
.github/ISSUE_TEMPLATE/feature-request.yml vendored Normal file
View File

@ -0,0 +1,64 @@
name: Feature request
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
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!"

20
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -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.

106
.github/release-drafter.yml vendored Normal file
View File

@ -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

1
pilot/server/knowledge/_cli/knowledge_cli.py
View File

@ -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",
)

2
pilot/utils/parameter_utils.py
View File

@ -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