Skip to content

Commit f813b73

Browse files
ritwik-gritwik-g
authored
Merge pull request #11 from Zipstack/4-add-base-classes-to-represent-the-yaml-structure-without-the-secrets
feat: implement logging and enhance GitHub workflows
2 parents 7879f61 + 2c6d045 commit f813b73

File tree

22 files changed

+1242
-74
lines changed

22 files changed

+1242
-74
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
name: 🐛 Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
- type: textarea
12+
id: bug-description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is
16+
placeholder: When I run X command, Y happens instead of Z...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps To Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Run command '...'
27+
2. With input '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
placeholder: The command should have...
38+
validations:
39+
required: true
40+
41+
- type: dropdown
42+
id: os
43+
attributes:
44+
label: Operating System
45+
description: What OS are you using?
46+
options:
47+
- macOS
48+
- Linux
49+
- Windows
50+
validations:
51+
required: true
52+
53+
- type: input
54+
id: python-version
55+
attributes:
56+
label: Python Version
57+
description: What version of Python are you using?
58+
placeholder: e.g., 3.9.6
59+
validations:
60+
required: true
61+
62+
- type: input
63+
id: helm-version
64+
attributes:
65+
label: Helm Version
66+
description: What version of Helm are you using?
67+
placeholder: e.g., 3.12.0
68+
validations:
69+
required: true
70+
71+
- type: input
72+
id: package-version
73+
attributes:
74+
label: Package Version
75+
description: What version of helm-values-manager are you using?
76+
placeholder: e.g., 0.1.0
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: logs
82+
attributes:
83+
label: Relevant Log Output
84+
description: Please copy and paste any relevant log output
85+
render: shell
86+
87+
- type: textarea
88+
id: additional
89+
attributes:
90+
label: Additional Context
91+
description: Add any other context about the problem here

‎.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: 💬 Questions & Discussions
4+
url: https://github.com/zipstack/helm-values-manager/discussions
5+
about: Please ask and answer questions here.
6+
- name: 📖 Documentation
7+
url: https://github.com/zipstack/helm-values-manager/tree/main/docs
8+
about: Check our documentation before creating an issue.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: 📚 Documentation
2+
description: Suggest improvements or report issues in documentation
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us improve our documentation!
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation Type
15+
description: What type of documentation needs attention?
16+
options:
17+
- README
18+
- API Documentation
19+
- Installation Guide
20+
- Usage Examples
21+
- Architecture/Design Docs
22+
- Contributing Guide
23+
- Other
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: current-issue
29+
attributes:
30+
label: Current Documentation Issue
31+
description: What's missing, unclear, or incorrect in the current documentation?
32+
placeholder: The current documentation lacks information about...
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: suggested-changes
38+
attributes:
39+
label: Suggested Changes
40+
description: Describe your suggested changes or additions
41+
placeholder: |
42+
The documentation should include:
43+
1. ...
44+
2. ...
45+
validations:
46+
required: true
47+
48+
- type: checkboxes
49+
id: checklist
50+
attributes:
51+
label: Checklist
52+
options:
53+
- label: I've checked that this isn't already documented somewhere else
54+
required: true
55+
- label: I've provided specific suggestions for improvement
56+
required: true
57+
- label: I've included examples where relevant
58+
required: false
59+
60+
- type: textarea
61+
id: additional
62+
attributes:
63+
label: Additional Context
64+
description: Add any other context about the documentation request here

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: ✨ Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to suggest a new feature!
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Please describe.
16+
placeholder: I'm always frustrated when [...]
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like
25+
placeholder: |
26+
A clear and concise description of what you want to happen.
27+
Include any specific implementation details you have in mind.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Alternative Solutions
35+
description: Describe alternatives you've considered
36+
placeholder: What other approaches could solve this problem?
37+
validations:
38+
required: false
39+
40+
- type: checkboxes
41+
id: requirements
42+
attributes:
43+
label: Requirements
44+
description: Please confirm these requirements
45+
options:
46+
- label: This feature aligns with the project's scope and goals
47+
required: true
48+
- label: I've checked that this feature doesn't already exist
49+
required: true
50+
- label: I've searched for existing feature requests
51+
required: true
52+
53+
- type: textarea
54+
id: acceptance-criteria
55+
attributes:
56+
label: Acceptance Criteria
57+
description: List the requirements that should be met
58+
placeholder: |
59+
- [ ] Feature does X when Y
60+
- [ ] Handles error case Z
61+
- [ ] Documentation updated
62+
- [ ] Tests added
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: additional
68+
attributes:
69+
label: Additional Context
70+
description: Add any other context about the feature request here

‎.github/pull_request_template.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Related Issues
2+
<!-- List any related issues this PR addresses using #issue-number -->
3+
Fixes #
4+
5+
## Changes Made
6+
<!-- Describe the changes you've made -->
7+
-
8+
-
9+
-
10+
11+
## Testing Done
12+
<!-- Describe the testing you've performed -->
13+
- [ ] Added unit tests
14+
- [ ] Added integration tests
15+
- [ ] Manually tested
16+
- [ ] Updated test documentation
17+
18+
## Checklist
19+
<!-- Please check all that apply -->
20+
- [ ] I have read the CONTRIBUTING guidelines
21+
- [ ] My code follows the project's style guidelines
22+
- [ ] I have added tests that prove my fix/feature works
23+
- [ ] I have updated the documentation accordingly
24+
- [ ] All new and existing tests passed
25+
- [ ] My commits follow the project's commit message convention
26+
27+
## Type of Change
28+
<!-- What type of change does this PR introduce? -->
29+
- [ ] Feature
30+
- [ ] Bug Fix
31+
- [ ] Documentation
32+
- [ ] Performance Improvement
33+
- [ ] Code Style Update
34+
- [ ] Refactoring
35+
- [ ] CI/CD
36+
- [ ] Other
37+
38+
## Breaking Change
39+
<!-- Does this PR introduce a breaking change? -->
40+
- [ ] No
41+
- [ ] Yes (please describe below)
42+
43+
### Breaking Change Description
44+
<!-- If this PR introduces a breaking change, describe it and migration steps -->
45+
46+
## Additional Information
47+
<!-- Add any other context about the PR here -->

‎.github/pull_request_template.yml‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
name: Pull Request
2+
description: Create a pull request
3+
title: "[PR]: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for creating this pull request! Please ensure you've read our contributing guidelines.
9+
10+
- type: input
11+
id: related-issues
12+
attributes:
13+
label: Related Issues
14+
description: List any related issues this PR addresses
15+
placeholder: "#123, #456"
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: changes
21+
attributes:
22+
label: Changes Made
23+
description: Describe the changes you've made
24+
placeholder: |
25+
- Added feature X
26+
- Fixed bug Y
27+
- Updated documentation for Z
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: testing
33+
attributes:
34+
label: Testing Done
35+
description: Describe the testing you've performed
36+
placeholder: |
37+
- Added unit tests for X
38+
- Added integration tests for Y
39+
- Manually tested scenario Z
40+
validations:
41+
required: true
42+
43+
- type: checkboxes
44+
id: checklist
45+
attributes:
46+
label: Pull Request Checklist
47+
description: Please check all that apply
48+
options:
49+
- label: I have read the CONTRIBUTING guidelines
50+
required: true
51+
- label: My code follows the project's style guidelines
52+
required: true
53+
- label: I have added tests that prove my fix/feature works
54+
required: true
55+
- label: I have updated the documentation accordingly
56+
required: true
57+
- label: All new and existing tests passed
58+
required: true
59+
- label: My commits follow the project's commit message convention
60+
required: true
61+
62+
- type: dropdown
63+
id: type
64+
attributes:
65+
label: Type of Change
66+
description: What type of change does this PR introduce?
67+
options:
68+
- Feature
69+
- Bug Fix
70+
- Documentation
71+
- Performance Improvement
72+
- Code Style Update
73+
- Refactoring
74+
- CI/CD
75+
- Other
76+
validations:
77+
required: true
78+
79+
- type: dropdown
80+
id: breaking
81+
attributes:
82+
label: Breaking Change
83+
description: Does this PR introduce a breaking change?
84+
options:
85+
- "No"
86+
- "Yes"
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: breaking-description
92+
attributes:
93+
label: Breaking Change Description
94+
description: If this PR introduces a breaking change, describe it and migration steps
95+
placeholder: Describe the breaking changes and how to migrate...
96+
97+
- type: textarea
98+
id: additional
99+
attributes:
100+
label: Additional Information
101+
description: Add any other context about the PR here

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,3 +184,6 @@ bin/
184184
.DS_Store
185185
.AppleDouble
186186
.LSOverride
187+
188+
# windsurf rules
189+
.windsurfrules

0 commit comments

Comments
 (0)