Skip to content

Commit 70361c2

Browse files
authored
init: base/test framework (#40)
1 parent ce694ed commit 70361c2

File tree

103 files changed

+14408
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+14408
-0
lines changed

.dockerignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file
2+
# Ignore build and test binaries.
3+
bin/
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: "Bug report"
2+
description: Report a bug to help improve the project.
3+
title: "bug: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to report this bug!
9+
10+
_The more information you share, the faster we can identify and fix the bug._
11+
12+
Prior to opening the issue, please make sure that you:
13+
14+
- Use English to communicate.
15+
- Search the [open issues](https://github.com/apache/api7-ingress-controller/issues) to avoid duplicating the issue.
16+
17+
- type: textarea
18+
id: current-behavior
19+
attributes:
20+
label: Current Behavior
21+
description: Describe the issue you are facing.
22+
placeholder: |
23+
What is the issue with the current behavior?
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: expected-behavior
28+
attributes:
29+
label: Expected Behavior
30+
description: Describe what you expected to happen.
31+
placeholder: |
32+
What did you expect to happen instead?
33+
validations:
34+
required: false
35+
- type: textarea
36+
id: error
37+
attributes:
38+
label: Error Logs
39+
description: Paste the error logs if any. You can change the [log level](https://github.com/apache/apisix/blob/617c325628f33961be67f61f0fa8002afc370e42/docs/en/latest/FAQ.md#how-to-change-the-log-level) to get a verbose error log.
40+
validations:
41+
required: false
42+
- type: textarea
43+
id: steps
44+
attributes:
45+
label: Steps to Reproduce
46+
description: Share the steps you took so that we can reproduce the issue. Reports without proper steps details will likely be closed.
47+
placeholder: |
48+
1. Install APISIX Ingress controller with the Helm chart.
49+
2. Create a Route with ApisixRoute resource.
50+
3. ...
51+
validations:
52+
required: true
53+
- type: textarea
54+
id: environment
55+
attributes:
56+
label: Environment
57+
description: Share your environment details. Reports without proper environment details will likely be closed.
58+
value: |
59+
- APISIX Ingress controller version (run `api7-ingress-controller version --long`)
60+
- Kubernetes cluster version (run `kubectl version`)
61+
- OS version if running APISIX Ingress controller in a bare-metal environment (run `uname -a`)
62+
validations:
63+
required: true
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "Feature Request"
2+
description: Suggest an enhancement to APISIX Ingress controller.
3+
title: "feat: As a user, I want to ..., so that ..."
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
_The more information you share, the faster we can help you._
9+
10+
Prior to opening the issue, please make sure that you:
11+
12+
- Use English to communicate.
13+
- Search the [open issues](https://github.com/apache/api7-ingress-controller/issues) to avoid duplicating the issue.
14+
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Description
19+
description: Describe the feature you would like to see.
20+
placeholder: |
21+
As a user, I want to ..., so that...
22+
validations:
23+
required: true
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: "Documentation Issue"
2+
description: Issues related to documentation.
3+
title: "docs: "
4+
labels: [doc]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
_The more information you share, the faster we can help you._
10+
11+
Prior to opening the issue, please make sure that you:
12+
13+
- Use English to communicate.
14+
- Search the [open issues](https://github.com/apache/api7-ingress-controller/issues) to avoid duplicating the issue.
15+
16+
- type: textarea
17+
id: current-state
18+
attributes:
19+
label: Current State
20+
description: Describe the current state of the documentation.
21+
placeholder: |
22+
The documentation for the function in this page (url) is missing ...
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: desired-state
27+
attributes:
28+
label: Desired State
29+
description: Describe the desired state the documentation should be in.
30+
placeholder: |
31+
There should be line mentioning how the function behaves when ...
32+
validations:
33+
required: true
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: "Performance issue"
2+
description: Report a performance issue.
3+
title: "perf: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to report this bug!
9+
10+
_The more information you share, the faster we can identify and fix the issue._
11+
12+
Prior to opening the issue, please make sure that you:
13+
14+
- Use English to communicate.
15+
- Search the [open issues](https://github.com/apache/api7-ingress-controller/issues) to avoid duplicating the issue.
16+
- type: textarea
17+
id: issue-faced
18+
attributes:
19+
label: Issue Faced
20+
description: Describe the performance issue you are facing.
21+
placeholder: |
22+
When running APISIX Ingress in EKS, I'm experiencing high latency when I make requests to...
23+
validations:
24+
required: false
25+
- type: textarea
26+
id: logs
27+
attributes:
28+
label: Logs
29+
description: Paste relevant logs if any. You can change the [log level](https://github.com/apache/apisix/blob/617c325628f33961be67f61f0fa8002afc370e42/docs/en/latest/FAQ.md#how-to-change-the-log-level) to get a verbose error log.
30+
validations:
31+
required: false
32+
- type: textarea
33+
id: steps
34+
attributes:
35+
label: Steps to Reproduce
36+
description: Share the steps to reproduce this issue if you have identified it.
37+
placeholder: |
38+
1. Install APISIX Ingress controller 1.x with the Helm chart.
39+
2. Create a Route with ApisixRoute resource.
40+
3. ...
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: environment
45+
attributes:
46+
label: Environment
47+
description: Share your environment details. Reports without proper environment details will likely be closed.
48+
value: |
49+
- APISIX Ingress controller version (run `api7-ingress-controller version --long`)
50+
- Kubernetes cluster version (run `kubectl version`)
51+
- OS version if running APISIX Ingress controller in a bare-metal environment (run `uname -a`)
52+
validations:
53+
required: true
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: "Request help"
2+
description: Please use this template for requesting help.
3+
title: "request help: "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
The more information you fill in, the better we can help you.
9+
10+
- Please use English on public channel.
11+
- Encourage using words rather than pictures to describe errors.
12+
- Encourage pre-searching with keywords in the issue.
13+
14+
- type: textarea
15+
id: description
16+
attributes:
17+
label: Issue description
18+
description: Provide a clear and concise description of the help you need.
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: environment
23+
attributes:
24+
label: Environment
25+
description: Request help without environment information will be ignored or closed.
26+
value: |
27+
- your api7-ingress-controller version (output of api7-ingress-controller version --long):
28+
- your Kubernetes cluster version (output of kubectl version):
29+
- if you run api7-ingress-controller in Bare-metal environment, also show your OS version (uname -a):
30+
validations:
31+
required: true

.github/PULL_REQUEST_TEMPLATE

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!-- Please answer these questions before submitting a pull request -->
2+
3+
### Type of change:
4+
5+
<!-- Please delete options that are not relevant. -->
6+
7+
<!-- Select all the options from below that matches the type your PR best -->
8+
9+
- [ ] Bugfix
10+
- [ ] New feature provided
11+
- [ ] Improve performance
12+
- [ ] Backport patches
13+
- [ ] Documentation
14+
- [ ] Refactor
15+
- [ ] Chore
16+
- [ ] CI/CD or Tests
17+
18+
### What this PR does / why we need it:
19+
20+
<!--- Why is this change required? What problem does it solve? -->
21+
<!--- If it fixes an open issue, please link to the issue here. -->
22+
23+
### Pre-submission checklist:
24+
25+
<!--
26+
Please follow the requirements:
27+
1. Use Draft if the PR is not ready to be reviewed
28+
2. Test is required for the feat/fix PR, unless you have a good reason
29+
3. Doc is required for the feat PR
30+
4. Use a new commit to resolve review instead of `push -f`
31+
5. Use "request review" to notify the reviewer once you have resolved the review
32+
-->
33+
34+
- [ ] Did you explain what problem does this PR solve? Or what new features have been added?
35+
- [ ] Have you added corresponding test cases?
36+
- [ ] Have you modified the corresponding document?
37+
- [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/api7-ingress-controller#community) first**

.github/release-drafter.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one
3+
# or more contributor license agreements. See the NOTICE file
4+
# distributed with this work for additional information
5+
# regarding copyright ownership. The ASF licenses this file
6+
# to you under the Apache License, Version 2.0 (the
7+
# "License"); you may not use this file except in compliance
8+
# with the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing,
13+
# software distributed under the License is distributed on an
14+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
# KIND, either express or implied. See the License for the
16+
# specific language governing permissions and limitations
17+
# under the License.
18+
#
19+
name-template: 'v$NEXT_PATCH_VERSION 🌈'
20+
tag-template: 'v$NEXT_PATCH_VERSION'
21+
categories:
22+
- title: '🚀 Features'
23+
labels:
24+
- 'feature'
25+
- 'enhancement'
26+
- title: '🐛 Bug Fixes'
27+
labels:
28+
- 'bugfix'
29+
- 'bug'
30+
- title: '🧰 Maintenance'
31+
label: 'area/dependencies'
32+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
33+
template: |
34+
## What's New
35+
$CHANGES
36+
37+
## 👨🏽‍💻 Contributors
38+
39+
Thank you to our contributors for making this release possible:
40+
$CONTRIBUTORS
41+

.github/semantic.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one
3+
# or more contributor license agreements. See the NOTICE file
4+
# distributed with this work for additional information
5+
# regarding copyright ownership. The ASF licenses this file
6+
# to you under the Apache License, Version 2.0 (the
7+
# "License"); you may not use this file except in compliance
8+
# with the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing,
13+
# software distributed under the License is distributed on an
14+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
# KIND, either express or implied. See the License for the
16+
# specific language governing permissions and limitations
17+
# under the License.
18+
#
19+
titleOnly: true
20+
allowRevertCommits: true
21+
types:
22+
- feat
23+
- fix
24+
- docs
25+
- style
26+
- refactor
27+
- perf
28+
- test
29+
- build
30+
- ci
31+
- chore
32+
- revert
33+
- change

0 commit comments

Comments
 (0)