Skip to content

Commit eac0ca3

Browse files
GA 2.0.0 release (#19)
Develop branch is ready for publication. --------- Co-authored-by: silabs-akosj <146345861+silabs-akosj@users.noreply.github.com>
1 parent e8a72e7 commit eac0ca3

File tree

1,003 files changed

+481380
-481086
lines changed

Some content is hidden

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

1,003 files changed

+481380
-481086
lines changed

.github/CODEOWNERS

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This is a # Default codeowners for the repository
2+
* @AndrasZiegler @silabs-TiborL

.github/CONTRIBUTING.md

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# Contributing to a SiliconLabs open source project
2+
3+
You want to contribute to a Silicon Labs Open Source project? Welcome! Please read this document to understand what you can do:
4+
* [Help Others](#help-others)
5+
* [Analyze Issues](#analyze-issues)
6+
* [Report an Issue](#report-an-issue)
7+
* [Contribute Code](#contribute-code)
8+
9+
## Help Others
10+
11+
You can help the Silicon Labs open source projects by helping others who use them and need support.
12+
13+
## Analyze Issues
14+
15+
Analyzing issue reports can be a lot of effort. Any help is welcome!
16+
Go to [Issue tracker](https://github.com/SiliconLabsSoftware/bluetooth-AoA-example/issues?q=is%3Aopen+is%3Aissue) and find an open issue which needs additional work or a bugfix (e.g. issues labeled with "help wanted" or "bug").
17+
18+
Additional work could include any further information, or a gist, or it might be a hint that helps understanding the issue. Maybe you can even find and [contribute](#contribute-code) a bugfix?
19+
20+
## Report an Issue
21+
22+
If you find a bug - behavior of Silicon Labs Open Source projects code contradicting your expectation - you are welcome to report it.
23+
We can only handle well-reported, actual bugs, so please follow the guidelines below.
24+
25+
Once you have familiarized with the guidelines, you can go to the [Create an issue](https://github.com/SiliconLabsSoftware/bluetooth-AoA-example/issues/new) to report the issue.
26+
27+
### Quick Checklist for Bug Reports
28+
29+
Issue report checklist:
30+
* Real, current bug
31+
* No duplicate
32+
* Reproducible
33+
* Good summary
34+
* Well-documented
35+
* Minimal example
36+
37+
38+
### Issue handling process
39+
40+
When an issue is reported, a committer will look at it and either confirm it as a real issue, close it if it is not an issue, or ask for more details.
41+
42+
An issue that is about a real bug is closed as soon as the fix is committed.
43+
44+
45+
### Reporting Security Issues
46+
47+
If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to the CODE_OWNERS, so we can fix it before it can be exploited.
48+
49+
50+
### Usage of Labels
51+
52+
GitHub offers labels to categorize issues. We defined the following labels so far:
53+
54+
Labels for issue categories:
55+
* bug: this issue is a bug in the code
56+
* feature: this issue is a request for a new functionality or an enhancement request
57+
58+
Status of open issues:
59+
* help wanted: the feature request is approved and you are invited to contribute
60+
61+
Status/resolution of closed issues:
62+
* wontfix: while acknowledged to be an issue, a fix cannot or will not be provided
63+
64+
The labels can only be set and modified by committers.
65+
66+
67+
### Issue Reporting Disclaimer
68+
69+
We want to improve the quality of Silicon Labs Open Source projects and good bug reports are welcome! But our capacity is limited, thus we reserve the right to close or to not process insufficient bug reports in favor of those which are very cleanly documented and easy to reproduce. Even though we would like to solve each well-documented issue, there is always the chance that it will not happen - remember: these projects are open source and comes without warranty.
70+
71+
Bug report analysis support is very welcome! (e.g. pre-analysis or proposing solutions)
72+
73+
74+
## Contribute Code
75+
76+
You are welcome to contribute code to Silicon Labs Open Source projects in order to fix bugs or to implement new features.
77+
78+
There are three important things to know:
79+
80+
1. You must be aware that you need to sign a [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) in order for your contribution to be accepted. This is common practice in all major Open Source projects.
81+
2. There are **several requirements regarding code style, quality, and product standards** which need to be met (we also have to follow them). The respective section below gives more details on the coding guidelines.
82+
83+
84+
### Contribution Content Guidelines
85+
86+
These are some of the rules we try to follow:
87+
88+
- Apply a clean coding style adapted to the surrounding code, even though we are aware the existing code is not fully clean
89+
- Use (4)spaces for indentation (except if the modified file consistently uses tabs)
90+
- Use variable naming conventions like in the other files you are seeing (camelcase)
91+
- No console.log() - use logging service
92+
- Run the ESLint code check and make it succeed
93+
- Comment your code where it gets non-trivial
94+
- Keep an eye on performance and memory consumption, properly destroy objects when not used anymore
95+
- Write a unit test
96+
- Do not do any incompatible changes, especially do not modify the name or behavior of public API methods or properties
97+
98+
### How to contribute - the Process
99+
100+
1. Make sure the change would be welcome (e.g. a bugfix or a useful feature); best do so by proposing it in a GitHub issue
101+
2. Create a branch forking the cla-assistant repository and do your change
102+
3. Commit and push your changes on that branch
103+
4. In the commit message
104+
- Describe the problem you fix with this change.
105+
- Describe the effect that this change has from a user's point of view. App crashes and lockups are pretty convincing for example, but not all bugs are that obvious and should be mentioned in the text.
106+
- Describe the technical details of what you changed. It is important to describe the change in a most understandable way so the reviewer is able to verify that the code is behaving as you intend it to.
107+
5. If your change fixes an issue reported at GitHub, add the following line to the commit message:
108+
- ```Fixes #(issueNumber)```
109+
- Do NOT add a colon after "Fixes" - this prevents automatic closing.
110+
6. Create a Pull Request
111+
7. Follow the link posted by the Silicon Labs Open Source projects to your pull request and accept it, as described in detail above.
112+
8. Wait for our code review and approval, possibly enhancing your change on request
113+
- Note that the Silicon Labs Open Source projects developers also have their regular duties, so depending on the required effort for reviewing, testing and clarification this may take a while
114+
115+
9. Once the change has been approved we will inform you in a comment
116+
10. We will close the pull request, feel free to delete the now obsolete branch

.github/Docker_readme.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Build docker image
2-
3-
Having a docker image for CICD is always a good way to secure the product development. Let's build a docker image.
4-
5-
## Readme
6-
7-
Please check the documentation in the main [README](../README.md) file.
1+
# Build docker image
2+
3+
Having a docker image for CICD is always a good way to secure the product development. Let's build a docker image.
4+
5+
## Readme
6+
7+
Please check the documentation in the main [README](../README.md) file.

.github/build-docker-image.sh

+53-53
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,53 @@
1-
#!/bin/sh
2-
3-
display_help() {
4-
echo "Usage: $0 -i image_name -v version -r registry -a architecture " >&2
5-
echo
6-
echo " -i image_name Specify the image name, for example: devs_xg24_aoa_poc"
7-
echo " -v version Specify the version of docker image, for example: 1.0.0"
8-
echo " -r registry Specify the Docker registry to push the image to (optional) example: lx0017637.silabs.com:5000"
9-
echo " If internal registry is used, SonarQube will be included."
10-
echo " -a architecture Specify the architecture, for example: x86_64 or aarch64"
11-
echo
12-
exit 1
13-
}
14-
15-
image_name=""
16-
version="1.0.0"
17-
registry="none"
18-
architecture="x86_64"
19-
run_sonarqube_scanner="false"
20-
21-
# Process the options
22-
while getopts ":h:i:v:r:a:" opt; do
23-
case $opt in
24-
h) display_help
25-
exit;;
26-
i) image_name="$OPTARG";;
27-
v) version="$OPTARG";;
28-
r) registry="$OPTARG";;
29-
a) architecture="$OPTARG";;
30-
\?) echo "Invalid option -$OPTARG" >&2
31-
display_help
32-
exit 1;;
33-
:) echo "Option -$OPTARG requires an argument." >&2
34-
display_help
35-
exit 1;;
36-
esac
37-
done
38-
39-
if [ "$registry" = "lx0017637.silabs.com:5000" ] ; then
40-
echo "Internal silabs build with: $registry"
41-
run_sonarqube_scanner="true"
42-
fi
43-
44-
# Build the Docker image
45-
echo "Building Docker image: $image_name:$version for architecture: $architecture "
46-
docker build --build-arg ARCH="$architecture" --build-arg SONARQUBE="$run_sonarqube_scanner" -t "$image_name:$version" -f Dockerfile .
47-
48-
if [ -n "$registry" ] && [ "$registry" != "none" ] ; then
49-
docker tag "$image_name:$version" "$registry/$image_name:$version"
50-
docker push "$registry/$image_name:$version"
51-
else
52-
echo "Docker registry not specified, skipping tagging and pushing."
53-
fi
1+
#!/bin/sh
2+
3+
display_help() {
4+
echo "Usage: $0 -i image_name -v version -r registry -a architecture " >&2
5+
echo
6+
echo " -i image_name Specify the image name, for example: devs_xg24_aoa_poc"
7+
echo " -v version Specify the version of docker image, for example: 1.0.0"
8+
echo " -r registry Specify the Docker registry to push the image to (optional) example: lx0017637.silabs.com:5000"
9+
echo " If internal registry is used, SonarQube will be included."
10+
echo " -a architecture Specify the architecture, for example: x86_64 or aarch64"
11+
echo
12+
exit 1
13+
}
14+
15+
image_name=""
16+
version="1.0.0"
17+
registry="none"
18+
architecture="x86_64"
19+
run_sonarqube_scanner="false"
20+
21+
# Process the options
22+
while getopts ":h:i:v:r:a:" opt; do
23+
case $opt in
24+
h) display_help
25+
exit;;
26+
i) image_name="$OPTARG";;
27+
v) version="$OPTARG";;
28+
r) registry="$OPTARG";;
29+
a) architecture="$OPTARG";;
30+
\?) echo "Invalid option -$OPTARG" >&2
31+
display_help
32+
exit 1;;
33+
:) echo "Option -$OPTARG requires an argument." >&2
34+
display_help
35+
exit 1;;
36+
esac
37+
done
38+
39+
if [ "$registry" = "lx0017637.silabs.com:5000" ] ; then
40+
echo "Internal silabs build with: $registry"
41+
run_sonarqube_scanner="true"
42+
fi
43+
44+
# Build the Docker image
45+
echo "Building Docker image: $image_name:$version for architecture: $architecture "
46+
docker build --build-arg ARCH="$architecture" --build-arg SONARQUBE="$run_sonarqube_scanner" -t "$image_name:$version" -f Dockerfile .
47+
48+
if [ -n "$registry" ] && [ "$registry" != "none" ] ; then
49+
docker tag "$image_name:$version" "$registry/$image_name:$version"
50+
docker push "$registry/$image_name:$version"
51+
else
52+
echo "Docker registry not specified, skipping tagging and pushing."
53+
fi

.github/build-with-docker.sh

+61-61
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,61 @@
1-
#!/bin/sh
2-
3-
display_help() {
4-
echo "Usage: $0 -i image_name -v version -r registry -a architecture -c clean" >&2
5-
echo
6-
echo " -i image_name Specify the image name, for example: devs_xg24_aoa_poc"
7-
echo " -v version Specify the version of docker image, for example: 1.0.0"
8-
echo " -r registry Specify the Docker registry to push the image to"
9-
echo " -a architecture Specify the architecture, for example: x86_64 or aarch64 (optional)"
10-
echo " -c clean Specify 'clean' to remove the built Docker image"
11-
echo
12-
exit 1
13-
}
14-
15-
image_name="devs_xg24_aoa_poc"
16-
version="1.0.0"
17-
registry="none"
18-
architecture="x86_64"
19-
clean="false"
20-
21-
while getopts ":hi:v:r:a:c" opt; do
22-
case ${opt} in
23-
h )
24-
display_help
25-
exit 1;;
26-
i )
27-
image_name=$OPTARG;;
28-
v )
29-
version=$OPTARG;;
30-
r )
31-
registry=$OPTARG;;
32-
a )
33-
architecture=$OPTARG;;
34-
c )
35-
clean="true";;
36-
\? )
37-
display_help
38-
exit 1 ;;
39-
: )
40-
echo "Invalid option: $OPTARG requires an argument" 1>&2
41-
display_help
42-
exit 1 ;;
43-
esac
44-
done
45-
shift $((OPTIND -1))
46-
47-
echo "<----- Docker based Weber Wasp project building script ----->"
48-
49-
echo "Calling the docker image builder script..."
50-
51-
# Call build-docker-image.sh with arguments
52-
sh ./.github/build-docker-image.sh -i $image_name -v $version -r $registry -a $architecture || { echo "Failed to build the Docker image"; exit 1; }
53-
54-
echo "<----- Running the docker based build environment ----->"
55-
# Run the docker image
56-
docker run -u root --rm -v $(pwd):/home/jenkins/devs_xg24_aoa_poc $image_name:$version /bin/sh -c "cd devs_xg24_aoa_poc && make all"
57-
58-
if [ "$clean" = "true" ]; then
59-
docker rmi $image_name:$version
60-
echo "Clean mode activated. Docker image $image_name:$version is removed."
61-
fi
1+
#!/bin/sh
2+
3+
display_help() {
4+
echo "Usage: $0 -i image_name -v version -r registry -a architecture -c clean" >&2
5+
echo
6+
echo " -i image_name Specify the image name, for example: devs_xg24_aoa_poc"
7+
echo " -v version Specify the version of docker image, for example: 1.0.0"
8+
echo " -r registry Specify the Docker registry to push the image to"
9+
echo " -a architecture Specify the architecture, for example: x86_64 or aarch64 (optional)"
10+
echo " -c clean Specify 'clean' to remove the built Docker image"
11+
echo
12+
exit 1
13+
}
14+
15+
image_name="devs_xg24_aoa_poc"
16+
version="1.0.0"
17+
registry="none"
18+
architecture="x86_64"
19+
clean="false"
20+
21+
while getopts ":hi:v:r:a:c" opt; do
22+
case ${opt} in
23+
h )
24+
display_help
25+
exit 1;;
26+
i )
27+
image_name=$OPTARG;;
28+
v )
29+
version=$OPTARG;;
30+
r )
31+
registry=$OPTARG;;
32+
a )
33+
architecture=$OPTARG;;
34+
c )
35+
clean="true";;
36+
\? )
37+
display_help
38+
exit 1 ;;
39+
: )
40+
echo "Invalid option: $OPTARG requires an argument" 1>&2
41+
display_help
42+
exit 1 ;;
43+
esac
44+
done
45+
shift $((OPTIND -1))
46+
47+
echo "<----- Docker based Weber Wasp project building script ----->"
48+
49+
echo "Calling the docker image builder script..."
50+
51+
# Call build-docker-image.sh with arguments
52+
sh ./.github/build-docker-image.sh -i $image_name -v $version -r $registry -a $architecture || { echo "Failed to build the Docker image"; exit 1; }
53+
54+
echo "<----- Running the docker based build environment ----->"
55+
# Run the docker image
56+
docker run -u root --rm -v $(pwd):/home/jenkins/devs_xg24_aoa_poc $image_name:$version /bin/sh -c "cd devs_xg24_aoa_poc && make all"
57+
58+
if [ "$clean" = "true" ]; then
59+
docker rmi $image_name:$version
60+
echo "Clean mode activated. Docker image $image_name:$version is removed."
61+
fi

0 commit comments

Comments
 (0)