Correct and improve checks #90
Merged
Conversation
This file contains hidden or 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
per1234
force-pushed
the
per1234/fix-check-configurations
branch
from
dccd752 to
2eb3e40
Compare
Some of the checks were incorrectly configured.
This will make it more clear to the user which think the error message is referring to.
The check functions already return this information, but the template was omitted from the error messages. Displaying the actual file name in the error message may help the user to understand the cause of the check failure.
Return an explanatory message when it is impossible to run a check due to the required information being unavailable. Previously, the infrastructure was in place to display this output to the user, but there was no output to display, so you just got a confusing "notice:" output with no notice to follow.
…/checkfunctions.go check/checkfunctions/checkfunctions.go will contain check functions that aren't specific to a single project type. There are a large, ever increasing, number of tests for check functions, and each group of check function types may have different testing requirements, so it's helpful to split them up a bit.
This makes the superproject type accessible to the check functions. This allows the check to determine whether the project is a subproject, which may require different handling.
The superproject should have a readme, but it's not necessarily essential for the subproject to have one as well.
per1234
force-pushed
the
per1234/fix-check-configurations
branch
from
2eb3e40 to
12170ff
Compare
silvanocerza
approved these changes
Dec 7, 2020
per1234
added
topic: code
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.
Some of the check configurations were incorrect.
Some of the check functions were not behaving in an ideal manner.
None of the check functions were providing helpful output when they couldn't/shouldn't be run.
This PR resolves those issues.