Temporarily disable platform documentation rules #166
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Although the official boards platforms are located in the root of the repository, some 3rd party platforms have the platform under the architecture subfolder of the repository in order to be friendly to manual installation (Boards Manager installation automatically generates this folder). The problem is that the license and readme should be in the repo root, but the project path is not the repository root when this alternative repository structure is in use. So this results in a false positive from the readme and license checks. It's only a warning when not in strict mode, but having a spurious warning is annoying and also blocks people from being able to use strict mode. These are important rules and I plan to find a solution to allow this rule to be applied to platforms of both structures once the development resources are available to make this happen. But since the rule is currently not compatible with all valid use cases, the best immediate action is to disable it.
per1234
added
priority: medium
silvanocerza
approved these changes
Mar 9, 2021
rsora
added
criticality: medium
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Although the official boards platforms are located in the root of the repository, some 3rd party platforms have the platform under the architecture subfolder of the repository in order to be friendly to manual installation (Boards Manager installation automatically generates this folder).
The problem is that the license and readme should be in the repo root, but the project path is not the repository root when this alternative repository structure is in use. So this results in a false positive from the readme and license checks.
It's only a warning when not in strict mode, but having a spurious warning is annoying and also blocks people from being able to use strict mode.
These are important rules and I plan to find a solution to allow this rule to be applied to platforms of both structures once the development resources are available to make this happen. But since the rule is currently not compatible with all valid use cases, the best immediate action is to disable it.