Skip to content

Commit 5777f10

Browse files
committed
Temporarily disable platform documentation rules
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.
1 parent 15c986b commit 5777f10

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

internal/rule/ruleconfiguration/ruleconfiguration.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -1410,8 +1410,8 @@ var configurations = []Type{
14101410
Brief: "no readme",
14111411
Description: "",
14121412
MessageTemplate: "No readme found. Please document your boards platform. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-readmes",
1413-
DisableModes: nil,
1414-
EnableModes: []rulemode.Type{rulemode.Default},
1413+
DisableModes: []rulemode.Type{rulemode.Default},
1414+
EnableModes: nil,
14151415
InfoModes: nil,
14161416
WarningModes: []rulemode.Type{rulemode.Default},
14171417
ErrorModes: []rulemode.Type{rulemode.Strict},
@@ -1426,8 +1426,8 @@ var configurations = []Type{
14261426
Brief: "no license file",
14271427
Description: "",
14281428
MessageTemplate: "No license file found. See: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/licensing-a-repository#detecting-a-license",
1429-
DisableModes: nil,
1430-
EnableModes: []rulemode.Type{rulemode.Default},
1429+
DisableModes: []rulemode.Type{rulemode.Default},
1430+
EnableModes: nil,
14311431
InfoModes: nil,
14321432
WarningModes: []rulemode.Type{rulemode.Default},
14331433
ErrorModes: []rulemode.Type{rulemode.Strict},

0 commit comments

Comments
 (0)