You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/overview/motivation.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,12 @@ Background
11
11
12
12
The introduction of `arduino-cli <https://docs.arduino.cc/arduino-cli/>`_ has been a significant step forward in enabling programmatic handling of the Arduino toolchain and processes. This has opened up possibilities for automation via scripts and command line interfaces, making it easier to integrate tasks like build verification and testing into continuous integration servers.
13
13
14
-
Current State and Objectives
14
+
Current state and objectives
15
15
----------------------------
16
16
17
17
While existing DevOps solutions, such as `compile-sketches action <https://github.com/arduino/compile-sketches>`_, provide some functionality, they do not fully meet our requirements. This project aims to fill this gap by providing a collection of utilities that solve specific DevOps use cases for managing Arduino assets. The scope of this project is intentionally open-ended, allowing it to evolve and adapt to emerging needs.
18
18
19
-
Key Features and Design Principles
19
+
Key features and design principles
20
20
----------------------------------
21
21
22
22
The project's features are designed to be used via command line interface, making it easy to integrate with any non-GUI CI/CD framework and environment. Python is the language of choice, ensuring cross-platform compatibility. Although our primary development and testing platform is Linux, we strive to ensure platform independence.
@@ -25,7 +25,7 @@ When applicable, the features presented rely on the Arduino `platform <https://d
25
25
26
26
The solutions provided for CI/CD are implemented through GitHub Actions `reusable workflows <https://docs.github.com/en/actions/sharing-automations/reusing-workflows>`_. This allows for easy deployment and upgrading of workflows with minimal effort. Given GitHub's popularity among Arduino developers, we have chosen to focus on GitHub Actions initially. However, we believe it should be straightforward to port the workflows to other CI/CD frameworks, such as GitLab, Jenkins, or Travis.
27
27
28
-
Community Engagement and Contributions
28
+
Community engagement and contributions
29
29
--------------------------------------
30
30
31
31
We believe these tools can be of general interest and applicability to any Arduino library or core developer. We encourage users to try them out, provide feedback, and contribute to making them more extensible and adaptable to various use cases.
Copy file name to clipboardExpand all lines: docs/overview/usage.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,20 +5,20 @@ This repository is designed to automate DevOps processes for Arduino libraries a
5
5
Thus, we recommend starting by adding the available `reusable workflows <https://github.com/Infineon/arduino-devops/tree/main/.github/workflows>`_ to your GitHub-hosted library or core.
6
6
Before running the workflows, you'll need to configure them with some minimal settings.
7
7
8
-
Step-by-Step Enablement
8
+
Step-by-step enablement
9
9
-----------------------
10
10
11
11
To begin, we recommend following our Getting Started guides, which will walk you through the process of enabling the workflows:
12
12
13
13
- :ref:`Getting started with compile-examples <compile_examples_getting_started>` workflow enablement. Learn how to set up the compile-examples workflow and start automating your build processes.
14
14
- :ref:`Getting started with release <release_getting_started>` workflow enablement. Discover how to enable the release workflow and streamline your library or core releases.
15
15
16
-
Advanced Customizations and Local Usage
16
+
Advanced customizations and local usage
17
17
---------------------------------------
18
18
19
19
As you become more familiar with the workflows and scripts, you might need advanced customizations to tailor them to your needs. You can also use the scripts locally on your development machine.
20
20
21
-
Running Scripts Locally
21
+
Running scripts locally
22
22
~~~~~~~~~~~~~~~~~~~~~~~
23
23
24
24
To run the scripts locally, first ensure you have the required dependencies installed (see :ref:`Requirements <requirements>`).
0 commit comments