ci(component): Check if examples declared and folders match #12151

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.

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

Jump to bottom

Open

lucasssvaz wants to merge 1 commit into espressif:master

from lucasssvaz:ci/idf_examples_check

Open

ci(component): Check if examples declared and folders match #12151

lucasssvaz wants to merge 1 commit into espressif:master from lucasssvaz:ci/idf_examples_check

+36 −0

Conversation

@lucasssvaz

Copy link

Member

@lucasssvaz lucasssvaz commented Dec 18, 2025

Description of Change

This pull request adds a new GitHub Actions workflow job to automatically verify that the examples listed in idf_component.yml match the directories present in the idf_component_examples folder. This helps ensure consistency between the declared and actual examples in the repository.

CI consistency improvements:

Added a check-examples job to .github/workflows/build_component.yml that compares the examples declared in idf_component.yml with the folders present in idf_component_examples, and fails the workflow if any mismatches are found.

Test Scenarios

Tested locally

@lucasssvaz


 ci(component): Check if examples declared and folders match

f15a8e9

@lucasssvaz lucasssvaz requested a review from me-no-dev

December 18, 2025 18:57

@lucasssvaz lucasssvaz self-assigned this

Dec 18, 2025

@lucasssvaz lucasssvaz added Type: CI & Testing Area: Arduino as ESP-IDF component labels

Dec 18, 2025

@github-actions

Copy link

Contributor

github-actions bot commented Dec 18, 2025

Messages
📖	🎉 Good Job! All checks are passing!

👋 Hello lucasssvaz, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against f15a8e9