Skip to content

Commit 5854074

Browse files
owndevowndev
authored
Merge pull request #153 from owndev/152-implement-new-workflows-for-automated-releases-and-versioning
Enhance GitHub workflows and update issue templates and README
2 parents 71b6734 + 4861942 commit 5854074

17 files changed

Lines changed: 960 additions & 395 deletions

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
name: Bug report
2+
description: Report a reproducible defect in a pipeline, filter, documentation flow, or repository automation.
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
- triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to report a bug.
12+
13+
Please include enough detail for maintainers to reproduce the issue quickly. If the bug involves credentials or sensitive configuration, redact secrets before posting.
14+
15+
- type: checkboxes
16+
id: checks
17+
attributes:
18+
label: Before submitting
19+
description: Confirm the basics so we can focus on the fix instead of detective work.
20+
options:
21+
- label: I searched existing issues and did not find a matching report.
22+
required: true
23+
- label: I can reproduce this issue on the latest version of the repository or current `main` branch.
24+
required: true
25+
- label: I removed or masked secrets, tokens, and private endpoints from my report.
26+
required: true
27+
28+
- type: dropdown
29+
id: area
30+
attributes:
31+
label: Affected area
32+
description: Which part of the project is affected?
33+
options:
34+
- pipelines/azure
35+
- pipelines/google
36+
- pipelines/infomaniak
37+
- pipelines/n8n
38+
- filters
39+
- docs
40+
- CI / GitHub workflows
41+
- Other / unsure
42+
validations:
43+
required: true
44+
45+
- type: input
46+
id: summary
47+
attributes:
48+
label: Bug summary
49+
description: A short, specific summary of the problem.
50+
placeholder: Streaming stops after the first chunk when using the n8n pipeline
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: current-behavior
56+
attributes:
57+
label: Current behavior
58+
description: What happened? Include the visible failure, incorrect output, or broken workflow.
59+
placeholder: |
60+
The request starts correctly, then the stream closes without a completion event.
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: expected-behavior
66+
attributes:
67+
label: Expected behavior
68+
description: What should have happened instead?
69+
placeholder: The stream should continue until the final event and emit a completion status.
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: reproduction
75+
attributes:
76+
label: Steps to reproduce
77+
description: Provide a minimal, numbered reproduction.
78+
placeholder: |
79+
1. Configure the n8n pipeline with ...
80+
2. Send a chat request with ...
81+
3. Observe that ...
82+
validations:
83+
required: true
84+
85+
- type: textarea
86+
id: logs
87+
attributes:
88+
label: Relevant logs, errors, or screenshots
89+
description: Paste stack traces, HTTP payload snippets, or screenshots when helpful.
90+
render: shell
91+
validations:
92+
required: false
93+
94+
- type: textarea
95+
id: environment
96+
attributes:
97+
label: Environment details
98+
description: Include the versions and environment details that matter.
99+
placeholder: |
100+
- OS:
101+
- Python version:
102+
- Open WebUI version:
103+
- Repository commit or release:
104+
- Provider / model:
105+
- Deployment method:
106+
validations:
107+
required: true
108+
109+
- type: textarea
110+
id: context
111+
attributes:
112+
label: Additional context
113+
description: Link related issues, PRs, docs, or anything else that could speed up diagnosis.
114+
validations:
115+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Read the documentation
4+
url: https://github.com/owndev/Open-WebUI-Functions/blob/main/README.md
5+
about: Start with the README and provider-specific docs before opening a support request.
6+
- name: Review the contributing guide
7+
url: https://github.com/owndev/Open-WebUI-Functions/blob/main/.github/CONTRIBUTING.md
8+
about: Learn the preferred workflow for feature proposals, pull requests, and repository contributions.

‎.github/ISSUE_TEMPLATE/contribute-your-own-feature.yaml‎

Lines changed: 0 additions & 78 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/documentation-improvement.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Documentation improvement
2+
description: Suggest missing, unclear, outdated, or incorrect documentation.
3+
title: "[Docs]: "
4+
labels:
5+
- documentation
6+
- triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Help us keep the docs sharp, current, and friendly for contributors.
12+
13+
- type: checkboxes
14+
id: checks
15+
attributes:
16+
label: Before submitting
17+
options:
18+
- label: I checked the current documentation and existing issues first.
19+
required: true
20+
21+
- type: dropdown
22+
id: scope
23+
attributes:
24+
label: Documentation area
25+
description: Which area should be updated?
26+
options:
27+
- README.md
28+
- CONTRIBUTING.md
29+
- docs/azure*
30+
- docs/google*
31+
- docs/n8n*
32+
- docs/infomaniak*
33+
- filters
34+
- pipelines
35+
- GitHub templates / workflows
36+
- Other / unsure
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: issue
42+
attributes:
43+
label: What needs to change?
44+
description: Describe the gap, ambiguity, or incorrect information.
45+
placeholder: The setup guide skips the required environment variable for ...
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: improvement
51+
attributes:
52+
label: Suggested improvement
53+
description: Tell us how the docs could be improved.
54+
placeholder: Add a short prerequisites section and an example configuration block.
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: references
60+
attributes:
61+
label: References or examples
62+
description: Link related files, screenshots, external docs, or examples.
63+
validations:
64+
required: false

‎.github/ISSUE_TEMPLATE/documentation-update.yaml‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature-contribution.yml‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Feature contribution proposal
2+
description: Coordinate a feature you plan to implement yourself and submit as a pull request.
3+
title: "[Contribution]: "
4+
labels:
5+
- enhancement
6+
- contribution
7+
- triage
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Use this form when you intend to build the feature yourself.
13+
14+
Opening this issue first helps maintainers confirm fit, avoid duplicate work, and share early guidance before you invest serious implementation time.
15+
16+
- type: checkboxes
17+
id: checks
18+
attributes:
19+
label: Contribution checklist
20+
description: Please confirm the essentials.
21+
options:
22+
- label: I reviewed the [Contributing Guide](https://github.com/owndev/Open-WebUI-Functions/blob/main/.github/CONTRIBUTING.md).
23+
required: true
24+
- label: I reviewed the [Code of Conduct](https://github.com/owndev/Open-WebUI-Functions/blob/main/.github/CODE_OF_CONDUCT.md).
25+
required: true
26+
- label: I plan to implement this myself and open a pull request.
27+
required: true
28+
29+
- type: input
30+
id: title
31+
attributes:
32+
label: Proposed feature title
33+
description: Give the contribution a short and descriptive name.
34+
placeholder: Add retry backoff controls to the Azure AI Foundry pipeline
35+
validations:
36+
required: true
37+
38+
- type: dropdown
39+
id: area
40+
attributes:
41+
label: Primary area
42+
options:
43+
- pipelines/azure
44+
- pipelines/google
45+
- pipelines/infomaniak
46+
- pipelines/n8n
47+
- filters
48+
- docs
49+
- CI / GitHub workflows
50+
- Cross-cutting / multiple areas
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: problem
56+
attributes:
57+
label: Problem statement
58+
description: What user or maintainer problem does this work solve?
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: proposal
64+
attributes:
65+
label: Proposed implementation
66+
description: Describe your planned technical approach, affected files, and important design choices.
67+
placeholder: |
68+
- Add new valves for ...
69+
- Update request validation in ...
70+
- Extend docs in ...
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: milestones
76+
attributes:
77+
label: Delivery plan
78+
description: Outline tasks, milestones, or an expected PR breakdown.
79+
placeholder: |
80+
1. Prototype request validation changes
81+
2. Add tests or manual verification notes
82+
3. Update docs
83+
validations:
84+
required: false
85+
86+
- type: textarea
87+
id: feedback
88+
attributes:
89+
label: Feedback requested from maintainers
90+
description: List decisions, constraints, or open questions where early guidance would help.
91+
validations:
92+
required: false
93+
94+
- type: textarea
95+
id: references
96+
attributes:
97+
label: Additional context
98+
description: Link related issues, PRs, docs, upstream APIs, or examples.
99+
validations:
100+
required: false

0 commit comments

Comments
 (0)