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
Take over the junit-formatter? #7686
Comments
@coding-bunny That's fine by me, although I'm wondering if transferring the original repo is an option. We also have to consider the RubyGems deployment and a potential change to the name. Have you spoken with its author? // cc @mikian |
P.S. I took a look at the code and its so simple that we can potentially just add this as a built-in formatter in RuboCop itself. |
@coding-bunny I still would argue that running rubocop as part of CI tests is not best approach, as I see coding style issues more of Pull Request comments and part of workflow than failing tests (think hot fixes... sometimes we need to push ugly code to save the world). I did quickly look through CircleCI environment variables and running pronto with it should be as simple as adding |
@mikian : We have no choice, we use a custom implementation with plugins for RuboCop that cannot be run over CodeClimate, hence why we run it over our CI to ensure our code is correct. Also I don't agree with that vision you posted, nor am I open to discussing our reasons for that. The main reason is that we rely on the |
As for being a maintainer, more than happy to keep it going/alive if that is the desired approach compared to moving it into RuboCop itself. I'm more than happy to support either way, but that decision needs to be made by either you or the RuboCop team. |
I've trying on this formatter into RuboCop core since yesterday. I will be able to open a PR to RuboCop core when I have finished writing the test code and documentation. |
@coding-bunny To correct to avoid any misunderstandings, I was talking about pronto that literally runs same rubocop with same rules and custom code than you would normally run. It has nothing to do with CodeClimate. I do think that most of use cases where JUnit formatter is used would be better handled with PR comments, but as said, I understand this doesn't work for most people and I am not arguing of your possible reasoning - the usual way of fixing problem is usually just making problem go away completely :) |
I opened the PR #7701. |
Fixes rubocop#7686. This PR Adds new `JUnitFormatter` formatter based on rubocop-junit-formatter gem. https://github.com/mikian/rubocop-junit-formatter And this PR includes the following patch to implementation of `JUnitFormatter`. mikian/rubocop-junit-formatter#11. REXML gem has been bundled gem since Ruby 2.8.0-dev (Ruby 3.0), it is added to depend on gemspec. - https://bugs.ruby-lang.org/issues/16485 - ruby/ruby@c3ccf23
Fixes #7686. This PR Adds new `JUnitFormatter` formatter based on rubocop-junit-formatter gem. https://github.com/mikian/rubocop-junit-formatter And this PR includes the following patch to implementation of `JUnitFormatter`. mikian/rubocop-junit-formatter#11. REXML gem has been bundled gem since Ruby 2.8.0-dev (Ruby 3.0), it is added to depend on gemspec. - https://bugs.ruby-lang.org/issues/16485 - ruby/ruby@c3ccf23
Is your feature request related to a problem? Please describe.
CI systems such as CircleCI are limited in what kind of output formats they are able to parse. For RuboCop, the only parseable format they support at the moment is the JUnit XML format, which was originally done through the rubocop-junit-formatter gem
This gem however is no longer being maintained and has been archived on GitHub.
Describe the solution you'd like
Since the project is under the MIT license, I'd like to suggest that the RuboCop team forks and takes over the maintenance for this gem, making it an officially supported formatter for the project, allowing better integration with CircleCI systems
Describe alternatives you've considered
The archived repository recommends to use gems like Pronto. This however is quite an elaborate setup that needs to be done in order to get the desired output formatting.
Additional context
We run CircleCI ourselves for the majority of our projects like RuboCop does, and having any errors reported being easily readable in the test-result overview increases productivity.
I'd be more than happy to help maintain the gem if it's being taken over.
The text was updated successfully, but these errors were encountered: