Issue #7571: Update doc for AnnotationUseStyle#12775
Conversation
|
GitHub, generate site |
|
@naotokuwa please share cli output by copy/pasting cat/checkstyle execution into code blocks instead of screenshot in PR description, ie: Also please always include link to issue in PR description, if your PR completes work for the issue you can use "Closes #7571". |
|
Hi, Nick @nrmancuso
I have two additional questions.
|
"Github, generate site" will trigger a github action to generate our website; you will see a bot comment with a link soon :)
See my example above, you literally add the phrase "Closes #7571" <- note that this links to your issue
Edit the PR description, the less comments in the conversation thread, the better.
The only CI that is not passing right now is Travis, this failure is on our side, you can ignore it. If any other CI fail, investigate, read error messages attentively, and update PR with fix. |
|
@nrmancuso |
|
Hi, Nick @nrmancuso |
|
@naotokuwa CI is restarted, it should pass now that PR description is updated |
|
@nrmancuso Thank you! It seems all tests passed except for Travis! |
|
GitHub, generate website |
|
@Vyom-Yadav , can you help to review this PR first? |
|
@naotokuwa, can you rebase on latest master? I am not sure why our action to generate website is not working. |
|
Hi, Romani @romani |
|
|
Hi, Nick. @nrmancuso |
|
Please fetch first, |
a04e238 to
a13070f
Compare
|
Github, generate site |
|
Hi, @nrmancuso If you have an idea, could you tell me what my issue was for further contribution? I followed the below link and sent a PR. |
|
We are constantly merging new commits, so it is safe to assume that your local branch is never up to date :) Whenever I come to work on a PR branch, I always do: It is a good practice to always keep your PR branches up to date to avoid having strange issues that might be hard to diagnose. Also, when you are creating a new branch, make sure that master is up to date too, before you create it: then check out your new branch. |
|
@naotokuwa site generation is failing because you have renamed your fork. Your fork should be named |
|
@nrmancuso |
|
@naotokuwa a lot of our automation assumes that your branch is named the same as the main repo, it used to be more inconvenient to rename a forked repo so no one really did it in the past. Rename your fork, give it a few minutes, then comment in this PR with “GitHub, generate site” |
|
@nrmancuso |
|
GitHub, generate site |
|
Git commands that usually required https://checkstyle.org/beginning_development.html#Starting_Development |
|
Hi, @romani |
|
@naotokuwa you should keep one commit in your feature branch, and keep squashing new/ fixing up requested changes into it. Try to drop the commit from the other contributor, squash your commits into one, and rebase again. You can use interactive rebase for this, as you’ve mentioned above. |
|
GitHub, generate website |
0b00dfe to
f8d3e86
Compare
|
@nrmancuso |
|
I updated the codes, commit and PR description, but some of CI tests failed. Before pushing the new change to the remote, is there anyway I can confirm CI won't fail in addition to "mvn verify"? |
|
GitHub, generate website |
|
If no link to website posted by bot, please rebase PR on latest our master. |
f8d3e86 to
6aacbce
Compare
|
GitHub, generate website |
|
Github, generate site |
|
@naotokuwa , please add example for compact_no_array |
|
Hi , @romani |
|
No need, sorry Missed it. |
|
Code change is good. Please fix CI failure https://app.circleci.com/pipelines/github/checkstyle/checkstyle/17536/workflows/6c7b845a-6006-4783-ae02-5a82fd8a2b75/jobs/252020/artifacts |
|
@romani |
6aacbce to
5b8c272
Compare
|
Github, generate site |
|
@romani |
|
Github, generate site |
romani
left a comment
There was a problem hiding this comment.
awesome
last updates for clarity what is parameter of annotation:
5b8c272 to
18fef83
Compare
|
Github, generate site |
1 similar comment
|
Github, generate site |
romani
left a comment
There was a problem hiding this comment.
Ok to merge.
Thanks a lot!
Please help us to fix more issues.




Closes #7571
The default value properties

Web Page:
CLI:
To configure the check to enforce an expanded style, with a closing parenthesis and a trailing array comma set to never.

WebPage:
CLI:
To configure the check to enforce a compact style, with always including a closing parenthesis and ignoring a trailing array comma.

WebPage:
CLI:
To configure the check to enforce a trailing array comma, with ignoring the elementStyle and a closing parenthesis.

WebPage:
CLI: