|
1 |
| -# Arduino DevOps Tools and Utilities |
| 1 | +# Arduino DevOps |
| 2 | + |
| 3 | +This repository contains a **collection of utilities** designed to ease and support the **DevOps** of **Arduino third-party cores** and **libraries**. |
| 4 | + |
| 5 | +## Audience |
| 6 | + |
| 7 | +You might want to give this repository a try if: |
| 8 | + |
| 9 | +* You are a recurrent developer/maintainer 👩💻 of Arduino third-party cores or libraries . |
| 10 | +* You are struggling 😓 to consistently verify ✅ that your library or core works with a wide range of Arduino boards after each code change. |
| 11 | +* You are wasting your time by manually 🔨 creating releases and distributing your Arduino libraries or cores 📦. |
| 12 | +* You are looking for a way to automate 🪄 the build check or/and release processes of your Arduino assets. |
| 13 | + |
| 14 | +## Features |
| 15 | + |
| 16 | +Currently, following processes are supported: |
| 17 | + |
| 18 | +- **Build check.** Compile a matrix of Arduino sketches and boards easily, and check it continuously to ensure your code always works. |
| 19 | +- **Release management.** Create new releases of your Arduino libraries and cores effortlessly, ensuring the proper distribution generation and versioning. |
| 20 | + |
| 21 | +> [!NOTE] |
| 22 | +> This repository has been initially created by Infineon Technologies AG. |
| 23 | +While it is intended to be generic and extensible to any Arduino third-party core or library, we might have included certain feature or functionality that is specific to our use cases. Sorry 🙏. |
| 24 | +Please, [let us know](https://github.com/Infineon/arduino-devops/issues) if you find any such feature that is not generic enough, and we will try to make it more generic. |
| 25 | + |
| 26 | +## Getting started |
| 27 | + |
| 28 | +You can get started by enabling the following workflows for your Arduino assets: |
| 29 | + |
| 30 | +* [Enable *compile-examples* build check for Arduino assets](tutorial) |
| 31 | +* [Enable *release* management for Arduino assets](tutorial-release) |
| 32 | + |
| 33 | +## More information |
| 34 | + |
| 35 | +Find the complete information in the repo [docs](docs/). |
| 36 | + |
| 37 | +## Contributing |
| 38 | + |
| 39 | +We welcome contributions to this repository! |
| 40 | + |
| 41 | +If you have ideas, suggestions, or improvements, please go with the following approach: |
| 42 | + |
| 43 | +* Discuss 💬 it with us by opening an [issue](https://github.com/Infineon/arduino-devops/issues). |
| 44 | + |
| 45 | +If modifications to the repository are required: |
| 46 | + |
| 47 | +* [Fork](https://github.com/Infineon/arduino-devops/fork) ⤵ the repository, and work on your contribution. |
| 48 | + |
| 49 | +* Once you are ready, you can create [pull request](https://github.com/Infineon/arduino-devops/compare) to `main`. |
| 50 | + |
| 51 | +For small changes, like typos or fixes, or small improvements you can directly create the pull request without discussion 👉. |
| 52 | + |
| 53 | +Thanks a lot for your contribution! 🙏 |
| 54 | + |
| 55 | +## License |
| 56 | + |
| 57 | +See the [LICENSE](LICENSE.md) file for more details. |
0 commit comments