Skip to content

Add functionality to ignore library examples in CI for PlatformIO #1746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 21, 2022
Merged

Add functionality to ignore library examples in CI for PlatformIO #1746

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions CI/build/platformio-builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,26 @@
import subprocess
import sys

# Libraries that are not meant to be checked in CI by default
DEFAULT_IGNORED_LIBRARIES = (
"keyboard",
"mouse"
)


def run_platformio(example_path, boards):
return subprocess.call(
["platformio", "ci", example_path] + ["--board=" + b for b in boards]
)


def collect_examples(libs_dir):
def collect_examples(libs_dir, ignored_libraries=None):
ignored_libraries = ignored_libraries or []
examples = []
for lib in os.listdir(libs_dir):
if lib.lower() in ignored_libraries:
print(f"Skipping examples from the `{lib}` library...")
continue
lib_dir = os.path.join(libs_dir, lib)
examples_dir = os.path.join(lib_dir, "examples")
if os.path.isdir(examples_dir):
Expand All @@ -27,6 +37,9 @@ def collect_examples(libs_dir):
parser.add_argument(
"-b", "--board", action="append", help="board ID used for PlatformIO project"
)
parser.add_argument(
"-i", "--ignore-library", action="append", help="Library name to ignore when collecting project examples"
)


def main():
Expand All @@ -35,8 +48,12 @@ def main():
if boards is None:
boards = ["nucleo_f401re"]

ignored_libraries = args.ignore_library
if ignored_libraries is None:
ignored_libraries = DEFAULT_IGNORED_LIBRARIES

libs_dir = os.path.join(os.environ["GITHUB_WORKSPACE"], "libraries")
if any(run_platformio(example, boards) for example in collect_examples(libs_dir)):
if any(run_platformio(example, boards) for example in collect_examples(libs_dir, ignored_libraries)):
sys.exit(1)


Expand Down