diktat icon indicating copy to clipboard operation
diktat copied to clipboard

GitHub Marketplace: integrate diktat to the marketplace

Open orchestr7 opened this issue 3 years ago • 6 comments

Diktat: Kotlin Static Analyzer

Need to create an action inside of GitHub marketplace for Diktat

Default behaviour:

  1. Downloads latest versions of ktlint and diktat to GitHub.workspace/diktat
  2. Recursively runs ./ktlint -R diktat.jar --disabled_rules=standard on the default GitHub Actions root workspace: GitHub.workspace
  3. Stores the result into special directory with SARIF results
  4. Uploads SARIF results to GitHub

Extra (non-default) options

  1. If you wish to customise the behaviour of diktat - you can simply put diktat-analysis.yml into the root path of your project and provide it to the Action with config option;
  2. If you wish to customise the path that leads to the project - you can simply provide projectPath option that will be relative to your GitHub workspace

orchestr7 avatar Feb 17 '22 15:02 orchestr7

@icemachined if you would make a marketplace app for save-cloud - probably it would be easy to make the same for diktat

orchestr7 avatar May 15 '22 19:05 orchestr7

@nulls also mentioned a very good idea: what if we will be very aggressive and will make fixes and commit them automatically

orchestr7 avatar Jul 11 '22 15:07 orchestr7

We can also be less aggressive and propose changes as review comments, so that the user will be able to commit them using Github web UI

petertrr avatar Jul 11 '22 16:07 petertrr

We can also be less aggressive and propose changes as review comments, so that the user will be able to commit them using Github web UI

there will be too many commits, I guess...

orchestr7 avatar Jul 11 '22 16:07 orchestr7

These suggestions can be committed as a single commit using 'Add suggestion to batch' feature

petertrr avatar Jul 11 '22 16:07 petertrr

These suggestions can be committed as a single commit using 'Add suggestion to batch' feature

yeah, I forgot about this. Good idea

orchestr7 avatar Jul 11 '22 16:07 orchestr7