New Github workflow that provide links to test-configs but reuse contribution repo for report generation

[relentless-pursuit]

Resolves: #15234

doc how to use: https://github.com/checkstyle/test-configs/tree/main/AbbreviationAsWordInName/Example1#example1-configs

for later:

checkstyle/test-configs#131
checkstyle/test-configs#139
checkstyle/test-configs#140

example of usage: checkstyle-gsoc#7
checkstyle-gsoc#16
or bunch of any other PR: https://github.com/checkstyle-gsoc/checkstyle/pulls

also done:
The code changes also included the rocket symbol not working. This has been fixed and tested.

Link to the PR testing: checkstyle-gsoc#7

also done:
We need one PR at a time.

As you can see with changes in workflow to option c, i can only run the latest. Others will be cancelled in the same PR.

Link to PR: https://github.com/checkstyle-gsoc/pull/11

[relentless-pursuit]

[romani]

Please make CI green meanwhile we do review.

[romani]

Share link to PR where you did this testing

[romani]

Please confirm by test that only single workflow will trigger on trigger phrase. Either existing workflow or new.

[romani]

Items

[relentless-pursuit]

Share link to PR where you did this testing

checkstyle-gsoc#2

checkstyle-gsoc#2 (comment)
checkstyle-gsoc#2 (comment)

[relentless-pursuit]

https://github.com/checkstyle-gsoc/checkstyle/actions/runs/9914040056/job/27392335628

Here, is the workflow running.

This is the link to the PR: checkstyle-gsoc#1 where I am testing new changes.

[romani]

here is diff - https://www.diffchecker.com/Oj9yiOZe/ with original action

[romani]

@relentless-pursuit , please review all CIs and fix them all. Only one failure is expected is for nonaproved issue.

[relentless-pursuit]

@relentless-pursuit , please review all CIs and fix them all. Only one failure is expected is for nonaproved issue.

yes, trying to fix them

[romani]

Pull latest code from main repository, here are commands https://checkstyle.org/beginning_development.html#Starting_Development , there is video on how to do this

[relentless-pursuit]

Pull latest code from main repository, here are commands https://checkstyle.org/beginning_development.html#Starting_Development , there is video on how to do this

I know that. I was just focused on the lin github issue. Now, i have rebased. I guess other jobs related to checkstyle won't fail.

[romani]

https://ci.appveyor.com/project/Checkstyle/checkstyle/builds/50203364/job/6err460sotf7qxm1#L115

Before push please do on your local mvn verify it will save you a lot of time, as feedback on quality will be quicker.

[nrmancuso]

existing workflow is complicated and fragile, we won't be reusing this.

Dismissing this as I will never approve this copy-paste, and the PR will stand indefinitely

[relentless-pursuit]

checkstyle-gsoc#4

Link of the issue section which doesn't trigger the workflow after writing the command intended to trigger the workflow. So, far the workflow is trigger only if it is a PR comment.

[relentless-pursuit]

the above screenshots show that making a comment on the issue doesn't trigger any workflow. it is only reserved for PR comment.

[romani]

Ok to merge.

All other improvements for implementation will done in next PRs.
This works and others can start to use it they see it convenient.

Merge of this will also unblock testing of generated configs one by one

[rnveach]

#15235 (comment)
So we get a random error message if user mis-spells check or example? What if user uses \ instead of /? What if only check if given? Is the workflow sensitive to white space or new line after?

[romani]

User friendly messages are out of scope for now, this is just basic implementation that is already usable. Very fragile on user typos.

There will be a way more improvements but I highly recommend to do this in separate PRs.

[romani]

@rnveach , please review, we need to merge base version to start extensive testing and improvement on inner parts.

Example of usage in PR: checkstyle-gsoc#7

[romani]

Another example.
At #15334 , instead of placing links to PR.
@mahfouz72 can just do Github, generate report for NeedBraces/all-examples-in-one

[rnveach]

There will be a way more improvements but I highly recommend to do this in separate PRs.

Then point to issue where it is documented current issues and what will be fixed in the future.

I expected to see documentation of issues, especially around things I mentioned above.

[romani]

I placed few more links to PR description to mention that it is far from final version, there are a lot of rooms to improve.

Test-configs issue tracker contains more issues that describe what will happen this month.
August issues are not yet created, plan in gdoc

[rnveach]

@romani
#15234 (comment)

You may merge this if you really want to. I will be abstaining from approving.

[romani]

#15380 here is reminder to document, assignment to me