bf20287229
18910: CI: add bors.toml r=kaspar030 a=kaspar030 <!-- The RIOT community cares a lot about code quality. Therefore, before describing what your contribution is about, we would like you to make sure that your modifications are compliant with the RIOT coding conventions, see https://github.com/RIOT-OS/RIOT/blob/master/CODING_CONVENTIONS.md. --> ### Contribution description This adds configuration for [bors](https://bors.tech). This has been discussed in CI meetings. The intended workflow is: 1. regular PR commits get built by CI as usual, but doing a quick-build (building only a subset of all boards), unless "CI: full build" is set 2. once that passes and the PR is ACKed, instead of merging using the merge button, we use bors to merge by typing "bors merge". 3. bors takes the PR, pushes it to the "testing" branch 4. CI does a full build of "testing" 5. on success, bors merges testing into master The main benefits are 1. a quickbuild / full build scheme ("regular" PR builds will be <5 minutes, but only fully built branches get merged into master) 2. bors does "rollups", meaning, if multiple PRs are to be "bors merged", bors merges them together, tests them together and merges them together. That's more efficient than doing this sequentially, and prevents semantic merge conflicts (e.g., PR a and b pass CI individually, but fail when both merged, breaking master). Once fully implemented, using bors will be a workflow change (no more "pressing the green button", but typing "bors merge" instead). But we've been using bors for RIOT-OS/riotdocker for a long time now, the experience was good (as opposed to disruptive). This PR just adds the necessary bors configuration, and once merged will allow using bors to merge PRs using "bors merge", but the previous workflow is still in place (manual merging can be done, and "regular" PR builds are still full builds). <!-- Put here the description of your contribution: - describe which part(s) of RIOT is (are) involved - if it's a bug fix, describe the bug that it solves and how it is solved - you can also give more information to reviewers about how to test your changes --> ### Testing procedure <!-- Details steps to test your contribution: - which test/example to compile for which board and is there a 'test' command - how to know that it was not working/available in master - the expected success test output --> ### Issues/PRs references bors tracking issue: #18911 <!-- Examples: Fixes #1234. See also #5678. Depends on PR #9876. Please use keywords (e.g., fixes, resolve) with the links to the issues you resolved, this way they will be automatically closed when your pull request is merged. See https://help.github.com/articles/closing-issues-using-keywords/. --> Co-authored-by: Kaspar Schleiser <kaspar@schleiser.de> |
||
|---|---|---|
| .cargo | ||
| .github | ||
| .vscode | ||
| boards | ||
| bootloaders | ||
| core | ||
| cpu | ||
| dist | ||
| doc | ||
| drivers | ||
| examples | ||
| fuzzing | ||
| kconfigs | ||
| makefiles | ||
| pkg | ||
| sys | ||
| tests | ||
| .bandit | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| .murdock | ||
| .murdock.yml | ||
| bors.toml | ||
| CITATION.cff | ||
| CODE_OF_CONDUCT.md | ||
| CODEOWNERS | ||
| CODING_CONVENTIONS_C++.md | ||
| CODING_CONVENTIONS.md | ||
| CONTRIBUTING.md | ||
| doc.txt | ||
| Kconfig | ||
| LICENSE | ||
| LOSTANDFOUND.md | ||
| MAINTAINING.md | ||
| Makefile | ||
| Makefile.base | ||
| Makefile.dep | ||
| Makefile.features | ||
| Makefile.include | ||
| README.md | ||
| release-notes.txt | ||
| SECURITY.md | ||
| uncrustify-riot.cfg | ||
| Vagrantfile | ||
The friendly Operating System for IoT!
RIOT is a real-time multi-threading operating system that supports a range of devices that are typically found in the Internet of Things (IoT): 8-bit, 16-bit and 32-bit microcontrollers.
RIOT is based on the following design principles: energy-efficiency, real-time capabilities, small memory footprint, modularity, and uniform API access, independent of the underlying hardware (this API offers partial POSIX compliance).
RIOT is developed by an international open source community which is independent of specific vendors (e.g. similarly to the Linux community). RIOT is licensed with LGPLv2.1, a copyleft license which fosters indirect business models around the free open-source software platform provided by RIOT, e.g. it is possible to link closed-source code with the LGPL code.
FEATURES
RIOT provides features including, but not limited to:
- a preemptive, tickless scheduler with priorities
- flexible memory management
- high resolution, long-term timers
- MTD abstraction layer
- File System integration
- support 200+ boards based on AVR, MSP430, ESP8266, ESP32, RISC-V, ARM7 and ARM Cortex-M
- the native port allows to run RIOT as-is on Linux and BSD. Multiple instances of RIOT running on a single machine can also be interconnected via a simple virtual Ethernet bridge or via a simulated IEEE 802.15.4 network (ZEP)
- IPv6
- 6LoWPAN (RFC4944, RFC6282, and RFC6775)
- UDP
- RPL (storing mode, P2P mode)
- CoAP
- OTA updates via SUIT
- MQTT
- USB (device mode)
- Display / Touchscreen support
- CCN-Lite
- LoRaWAN
- UWB
- Bluetooth (BLE) via NimBLE
GETTING RIOT
The most convenient way to get RIOT is to clone it via Git
$ git clone https://github.com/RIOT-OS/RIOT
this will ensure that you get all the newest features and bug fixes with the caveat of an ever changing work environment.
If you prefer things more stable, you can download the source code of one of our quarter annual releases via Github as ZIP file or tarball. You can also checkout a release in a cloned Git repository using
$ git pull --tags
$ git checkout <YYYY.MM>
For more details on our release cycle, check our documentation.
GETTING STARTED
- You want to start the RIOT? Just follow our quickstart guide or try this tutorial. For specific toolchain installation, follow instructions in the getting started page.
- The RIOT API itself can be built from the code using doxygen. The latest version of the documentation is uploaded daily to doc.riot-os.org.
FORUM
Do you have a question, want to discuss a new feature, or just want to present your latest project using RIOT? Come over to our forum and post to your hearts content.
CONTRIBUTE
To contribute something to RIOT, please refer to our contributing document.
MAILING LISTS
- RIOT commits: commits@riot-os.org
- Github notifications: notifications@riot-os.org
LICENSE
- Most of the code developed by the RIOT community is licensed under the GNU Lesser General Public License (LGPL) version 2.1 as published by the Free Software Foundation.
- Some external sources, especially files developed by SICS are published under a separate license.
All code files contain licensing information.
For more information, see the RIOT website: