Skip to content

Add SuperprojectType field to check configuration #121

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

Merged
merged 6 commits into from
Dec 21, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Dec 20, 2020

In some cases, the context of the project is relevant to the check configuration. Previously, this was dealt with by the
code of the check function, but it seems more logical to handle it in the check configuration, since that is already
being done there with the project type.

@per1234 per1234 requested a review from rsora December 20, 2020 09:41
@per1234
Copy link
Contributor Author

per1234 commented Dec 21, 2020

The "Check documentation links" workflow failure is expected. It's caused by the repositories being private.

This change adds the possibility to use projecttype.All in check configurations.
In some cases, the context of the project is relevant to the check configuration. Previously, this was dealt with by the
code of the check function, but it seems more logical to handle it in the check configuration, since that is already
being done there with the project type.
The newly added field allows moving the implementation of this filter out of the check function and into the check
configuration. It also allows some simplification of the check function tests.
In the case of official platform bundled libraries, it doesn't make sense to req	uire the Arduino_ prefix since
equivalent platform bundled libraries are often provided by each platform, both official and 3rd party. The "namespace"
provided by the prefix is only needed in the context of standalone libraries. In the case of platform bundled libraries,
the platform can provide the branding.
These checks are irrelevant for bundled libraries.
Library Manager-specific checks are irrelevant for platform bundled libraries, and so should be skipped for those
projects.
@per1234 per1234 force-pushed the per1234/superproject-checkconfiguration-field branch from e5ad1d1 to 5c621be Compare December 21, 2020 15:26
@per1234 per1234 merged commit bc4c5ca into main Dec 21, 2020
@per1234 per1234 deleted the per1234/superproject-checkconfiguration-field branch December 21, 2020 15:33
@per1234 per1234 added topic: code Related to content of the project itself type: enhancement Proposed improvement labels Sep 29, 2021
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants