-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
224 changed files
with
9,350 additions
and
3,264 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
require: | ||
members: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
# For most projects, this workflow file will not need changing; you simply need | ||
# to commit it to your repository. | ||
# | ||
# You may wish to alter this file to override the set of languages analyzed, | ||
# or to provide custom queries or build logic. | ||
# | ||
# ******** NOTE ******** | ||
# We have attempted to detect the languages in your repository. Please check | ||
# the `language` matrix defined below to confirm you have the correct set of | ||
# supported CodeQL languages. | ||
# | ||
name: "CodeQL" | ||
|
||
on: | ||
push: | ||
branches: [ master, develop ] | ||
pull_request: | ||
# The branches below must be a subset of the branches above | ||
branches: [ master ] | ||
schedule: | ||
- cron: '24 2 * * *' | ||
|
||
jobs: | ||
analyze: | ||
name: Analyze | ||
runs-on: ubuntu-latest | ||
|
||
#strategy: | ||
#fail-fast: false | ||
#matrix: | ||
# language: [ 'c' ] | ||
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] | ||
# Learn more: | ||
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
|
||
# Initializes the CodeQL tools for scanning. | ||
- name: Initialize CodeQL | ||
uses: github/codeql-action/init@v1 | ||
# with: | ||
# languages: ${{ matrix.language }} | ||
# If you wish to specify custom queries, you can do so here or in a config file. | ||
# By default, queries listed here will override any specified in a config file. | ||
# Prefix the list here with "+" to use these queries and those in the config file. | ||
# queries: ./path/to/local/query, your-org/your-repo/queries@main | ||
|
||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java). | ||
# If this step fails, then you should remove it and run the build manually (see below) | ||
- name: Autobuild | ||
uses: github/codeql-action/autobuild@v1 | ||
|
||
# ℹ️ Command-line programs to run using the OS shell. | ||
# 📚 https://git.io/JvXDl | ||
|
||
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines | ||
# and modify them (or add more) to build your code if your project | ||
# uses a compiled language | ||
|
||
#- run: | | ||
# make bootstrap | ||
# make release | ||
|
||
- name: Perform CodeQL Analysis | ||
uses: github/codeql-action/analyze@v1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Contribution Guidelines | ||
|
||
The present document provides a set of guidelines to which contributors must adhere. | ||
|
||
|
||
- [Contribution Guidelines](#contribution-guidelines) | ||
- [Contributions Licensing](#contributions-licensing) | ||
- [Developer Certificate of Origin](#developer-certificate-of-origin) | ||
- [Code Coverage](#code-coverage) | ||
- [General considerations](#general-considerations) | ||
|
||
## Contributions Licensing | ||
|
||
Any contribution that you make to this repository will be under the Apache 2 License, as dictated by that [license](http://www.apache.org/licenses/LICENSE-2.0.html): | ||
|
||
~~~ | ||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
~~~ | ||
|
||
## Developer Certificate of Origin | ||
|
||
Contributors must sign-off each commit by adding a `Signed-off-by: ...` line to commit messages to certify that they have the right to submit the code they are contributing to the project according to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/). | ||
|
||
## Code Coverage | ||
|
||
As stated in [QUALITY.md](QUALITY.md), all contributions to the project must increase line code coverage. | ||
Because of this, contributors are asked to locally run a coverage assessment that ensures that code coverage has increased when compared to the latest execution of the [nightly coverage CI job](http://jenkins.eprosima.com:8080/view/Micro%20XRCE/job/Micro-XRCE-DDS-Client%20Nightly%20Master%20Linux/coverage/). | ||
|
||
## General considerations | ||
|
||
Any other contributing policy can be found in [eProsima general guidelines](https://github.com/eProsima/policies/blob/main/CONTRIBUTING.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Platform Support | ||
|
||
This document reflects the level of support offered by **eProsima Micro XRCE-DDS Client** on different platforms as per the following | ||
definitions: | ||
|
||
## Tier 1 | ||
|
||
Tier 1 platforms are subjected to our unit test suite and other testing tools on a frequent basis including continuous | ||
integration jobs and nightly jobs. | ||
Errors or bugs discovered in these platforms are prioritized for correction by the development team. | ||
Significant errors discovered in Tier 1 platforms can impact release dates and we strive to resolve all known high | ||
priority errors in Tier 1 platforms prior to new version releases. | ||
|
||
## Tier 2 | ||
|
||
Tier 2 platforms are subject to periodic CI testing which runs both builds and tests with publicly accessible results. | ||
The CI is expected to be run at least within a week from the last relevant changes for the current release of the **Micro XRCE-DDS Client**. | ||
Installation instructions should be available and up-to-date in order for a platform to be listed in this category. | ||
Package-level binary packages may not be provided but providing a downloadable archive of the built workspace is | ||
encouraged. | ||
Errors may be present in released product versions for Tier 2 platforms. | ||
Known errors in Tier 2 platforms will be addressed subject to resource availability on a best effort basis and may or | ||
may not be corrected prior to new version releases. | ||
One or more entities should be committed to continuing support of the platform. | ||
|
||
## Tier 3 | ||
|
||
Tier 3 platforms are those for which community reports indicate that the release is functional. | ||
The development team does not run the unit test suite nor perform any other tests on platforms in Tier 3. | ||
Community members may provide assistance with these platforms. | ||
|
||
## Platforms | ||
|
||
| Architecture | Ubuntu Focal (20.04) | Windows 10 (VS2019) | Debian Buster (10) | | ||
| ------------ | -------------------- | ------------------- | ------------------ | | ||
| amd64 | Tier 1 [s] | Tier 1 [s] | Tier 3 [s] | | ||
| amd32 | | Tier 1 [s] | | | ||
| arm64 | Tier 3 [s] | | Tier 3 [s] | | ||
| arm32 | Tier 3 [s] | | Tier 3 [s] | | ||
|
||
" [s] " Compilation from source. | ||
|
||
Other Tier 3 OS: | ||
|
||
* FreeRTOS | ||
* Zephyr RTOS | ||
* NuttX |
Oops, something went wrong.