refactor style check scripts #4270
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
AI Language ReviewUpon reviewing the differences between the two versions of the file, I've noticed the following areas that need improvement:
These areas require attention to ensure the documentation maintains a professional and respectful tone. The rest of the document seems to follow the established guidelines and presents instructions clearly. |
manolo
added a commit
that referenced
this pull request
Apr 28, 2025
* Initial scripting for rating the quality of a PR change to the docs via AI * First draft of the PR workflow; changes to the scripts to reflect Github environment * Added sparse checkout * Making the scripts executable and updating the workflow * Set executable flags. Updated all scripts to /bin/bash * Fixed paths in scripts and changed from choco to apt * Added repo parameter to workflow and updated the scripts to work with that - making them more universal * use setup-gh for installing gh, setup correctly env from secrets, use GITHUB_OUTPUT in the action, run gh if success (#4260) * use setup-gh for installing gh, setup correctly env from secrets, use GITHUB_OUTPUT in the action, run gh if success * use stderr * use echo -e * ignore files not ending in .java .tsx .adoc * Consider only files ending in .tsx .java and .adoc * find comment if exist * modify an adoc * use proper if blocks * typo in var name * change comment title * increase peter-evans action version * change action name * remove changes in adoc * refactor style check scripts (#4270) * move scripts to its own folder, and remove score * Adding changes to an adoc * remove changes in adoc * add headers to scripts * better structure of prompts (#4272) * better structure for prompts * improve even more and simplify prompts * Remove comment if no issues * ai should return empty string if no suggestions * small doc change * stress not to comment anything that is not modified * Revert "small doc change" This reverts commit 52ca11f. * Update scripts/style-check/user-prompt.txt Co-authored-by: Luciano Vernaschi <[email protected]> --------- Co-authored-by: Luciano Vernaschi <[email protected]> * Update .github/workflows/style.yml Co-authored-by: Zhe Sun <[email protected]> --------- Co-authored-by: edler-san <[email protected]> Co-authored-by: Luciano Vernaschi <[email protected]> Co-authored-by: Zhe Sun <[email protected]>
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.
No description provided.