.github/scripts/check_readme.sh: Added special project case #1962
+32
−7
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
- In the previous implementation, the script would throw an error if the project missed a certain section in the project/README.md file (e.g. No "Supported parts" section) - To solve this issue and not introduce a new flag (the project/README.md files don't include any flags) this script was updated to include a function for 'special' projects (special = projects which can't respect the README.md files template). Simply add the 'special' project to the the list, here in the script, thus the workflows won't fail saying that the README.md files don't respect the template. - Also updated the .github/scripts/README.md file to reflect the changes Signed-off-by: Cristian Mihai Popa <[email protected]>
cristianmihaipopa
requested review from
AndreiGrozav,
PopPaul2021,
acostina,
gastmaier and
sarpadi
as code owners
13 tasks
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.
PR Description
In the previous implementation, the script would throw an error if the project missed a certain section in the roject/README.md file (e.g. No "Supported parts" section). To solve this issue and not introduce a new flag (the project/README.md files don't include any flags) this script was updated to include a function for 'special' projects (special = projects which can't respect the README.md files template). Also updated the. github/scripts/README.md file to reflect the changes. The workflows should not fail for these types of projects.
PR Type
PR Checklist