-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve Github action for site generation to place a direct link to updated section #9274
Comments
how do we proceed with this? |
@aryaniiit002 it will be simpler for contributor to do not write anything in PR description. Especially, it is almost always a new contributors and it can be confusing for them. Also, not all contributors know what section each check belongs to. For example, implementation can grep diff between patch branch and master, extract section in xdocs. |
i keep searching about it but not getting, i know we can use git diff --stat may be but how do we copy or extract the output and similarly the section in docs? i need some time i can do this |
@aryaniiit002 I am not sure what exactly you are asking for. You can extract diff to some file using git diff to some file and after it you can try to extract information that can help to understand what check was affected. It can be some done in other ways, e.g. (stupid version, but possible)
Or by some other way. The main goal is to get page name and section name |
Fix is merged |
Example:
PR modify exact file src/xdocs/config_coding.xml (we need to get a list of changed files in xdocs folder) name/path of them matches name on html
https://github.com/checkstyle/checkstyle/pull/9234/files#diff-cd8c9a8c8d730d1c9a128300a5b0b8302beac605ae7e9d8486e18aae24c44270
in xml we can find
<subsection name="Examples" id="HiddenField_Examples">
first section from change.HiddenField is what we need to parse from this line.
Expected: post like #9234 (comment)
attention to additional link like:
checkstyle-diff-reports.s3.us-east-2.amazonaws.com/HiddenFieldBranch_2021153117/config_coding.html#HiddenField
The text was updated successfully, but these errors were encountered: