Skip to content

Commit 0f6c4f2

Browse files
🔧 Create pull request template
1 parent 300b57b commit 0f6c4f2

File tree

3 files changed

+763
-0
lines changed

3 files changed

+763
-0
lines changed
Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: ['bug', 'triage']
6+
assignees: ['dinushchathurya']
7+
8+
---
9+
10+
## 🐛 Bug Description
11+
12+
A clear and concise description of what the bug is.
13+
14+
## 🔄 To Reproduce
15+
16+
Steps to reproduce the behavior:
17+
18+
1. Set up workflow with configuration:
19+
```yaml
20+
# Paste your workflow configuration here
21+
```
22+
23+
2. Run the action with inputs:
24+
```yaml
25+
with:
26+
cluster-name: your-cluster
27+
region: your-region
28+
# Add other relevant inputs
29+
```
30+
31+
3. See error in logs
32+
33+
## ✅ Expected Behavior
34+
35+
A clear and concise description of what you expected to happen.
36+
37+
## ❌ Actual Behavior
38+
39+
What actually happened instead.
40+
41+
## 📊 Environment
42+
43+
**Action Version:**
44+
- [ ] v1.0.0
45+
- [ ] v2.0.0
46+
- [ ] Other: _____
47+
48+
**Infrastructure:**
49+
- [ ] Public EKS cluster
50+
- [ ] Private EKS cluster
51+
- [ ] Public Helm registry
52+
- [ ] Private Helm registry
53+
54+
**Runner Type:**
55+
- [ ] GitHub-hosted (ubuntu-latest)
56+
- [ ] Self-hosted
57+
- [ ] Other: _____
58+
59+
**AWS Region:** _____
60+
61+
**Tool Versions:**
62+
- kubectl: _____
63+
- Helm: _____
64+
- AWS CLI: _____
65+
66+
## 📝 Configuration
67+
68+
<details>
69+
<summary>Click to expand workflow configuration</summary>
70+
71+
```yaml
72+
# Paste your complete workflow file here
73+
name: Your Workflow Name
74+
on:
75+
# Your triggers
76+
77+
jobs:
78+
deploy:
79+
runs-on: # Your runner type
80+
steps:
81+
- name: Configure AWS Credentials
82+
uses: aws-actions/configure-aws-credentials@v4
83+
with:
84+
# Your AWS config
85+
86+
- name: Deploy to EKS
87+
uses: open-source-srilanka/eks-helm-client-github-action@v2.0.0
88+
with:
89+
# Your action configuration
90+
```
91+
92+
</details>
93+
94+
<details>
95+
<summary>Click to expand action inputs</summary>
96+
97+
```yaml
98+
# Paste your action configuration here
99+
with:
100+
cluster-name:
101+
region:
102+
private-cluster:
103+
helm-registry-url:
104+
# etc. - include all inputs you're using
105+
```
106+
107+
</details>
108+
109+
## 📜 Error Logs
110+
111+
<details>
112+
<summary>Click to expand error logs</summary>
113+
114+
```
115+
Paste the complete error logs from the GitHub Actions run here.
116+
Include any relevant kubectl, helm, or AWS CLI error messages.
117+
118+
Example sections to include:
119+
- Action startup logs
120+
- AWS credential configuration
121+
- EKS cluster connection attempts
122+
- Helm repository operations
123+
- kubectl commands
124+
- Error stack traces
125+
```
126+
127+
</details>
128+
129+
## 🔍 Additional Context
130+
131+
### Environment Details
132+
- Are you migrating from v1.0.0 to v2.0.0?
133+
- Does this work with other clusters/registries?
134+
- Any network restrictions or VPC configurations?
135+
- Any custom security policies or IAM restrictions?
136+
137+
### Network Configuration (if using private infrastructure)
138+
- VPC CIDR: _____
139+
- Subnet configuration: _____
140+
- Security group rules: _____
141+
- VPC endpoints configured: _____
142+
- NAT Gateway/Instance: _____
143+
144+
### AWS IAM Configuration
145+
- IAM role/user permissions: _____
146+
- EKS cluster auth mode: _____
147+
- Service account configuration: _____
148+
149+
### Helm Registry Details (if using private registry)
150+
- Registry type (Harbor, Nexus, ECR, etc.): _____
151+
- Authentication method: _____
152+
- Registry URL format: _____
153+
- SSL/TLS configuration: _____
154+
155+
## 📎 Screenshots
156+
157+
If applicable, add screenshots of:
158+
- GitHub Actions UI showing the error
159+
- AWS console configurations
160+
- Network/security group settings
161+
- Any relevant error messages
162+
163+
## 🔧 Troubleshooting Already Tried
164+
165+
Please check all that you have already attempted:
166+
167+
- [ ] I have searched existing issues to ensure this is not a duplicate
168+
- [ ] I have included the complete error logs
169+
- [ ] I have provided my workflow configuration
170+
- [ ] I have specified the action version I'm using
171+
- [ ] I have tested with debug mode enabled (`debug: true`)
172+
- [ ] I have verified my AWS credentials and permissions
173+
- [ ] I have confirmed the cluster name and region are correct
174+
- [ ] I have tested with a minimal configuration
175+
- [ ] I have tried increasing the timeout value
176+
- [ ] I have verified network connectivity (for private infrastructure)
177+
- [ ] I have checked VPC endpoints configuration (for private EKS)
178+
- [ ] I have validated Helm registry credentials (for private registries)
179+
- [ ] I have tried with different tool versions
180+
- [ ] I have tested the same configuration locally
181+
182+
### Specific Tests Performed
183+
184+
<details>
185+
<summary>Click to expand testing details</summary>
186+
187+
```bash
188+
# Commands you ran locally to test (if any)
189+
# kubectl commands
190+
# helm commands
191+
# AWS CLI commands
192+
# Network connectivity tests
193+
```
194+
195+
</details>
196+
197+
## 🚀 Workaround
198+
199+
If you found a temporary workaround, please describe it here to help others with the same issue.
200+
201+
```yaml
202+
# If you have a working configuration, share it here
203+
```
204+
205+
## 🎯 Impact
206+
207+
How is this bug affecting your work?
208+
209+
- [ ] **Critical** - Completely blocking deployment
210+
- [ ] **High** - Blocking some deployments/environments
211+
- [ ] **Medium** - Workaround exists but not ideal
212+
- [ ] **Low** - Minor inconvenience
213+
214+
## 📋 System Information
215+
216+
<details>
217+
<summary>Click to expand system information</summary>
218+
219+
**GitHub Actions Runner:**
220+
- Runner OS: _____
221+
- Runner version: _____
222+
- Docker version: _____
223+
224+
**EKS Cluster:**
225+
- Kubernetes version: _____
226+
- Platform version: _____
227+
- Endpoint access: _____
228+
- Logging enabled: _____
229+
230+
**Network Environment:**
231+
- VPC: _____
232+
- Subnets: _____
233+
- Internet connectivity: _____
234+
- Private DNS: _____
235+
236+
</details>
237+
238+
---
239+
240+
**Thank you for reporting this issue! We'll investigate and respond as soon as possible.**
241+
242+
## 📞 Additional Help
243+
244+
If this is an urgent production issue, you can also:
245+
- 📧 Email: [dinushchathurya21@gmail.com](mailto:dinushchathurya21@gmail.com)
246+
- 💬 Start a discussion for community help
247+
- 📚 Check our troubleshooting guide: [docs/examples/troubleshooting.md](docs/examples/troubleshooting.md)

0 commit comments

Comments
 (0)