Hey All,

I wanted to start a discussion on enabling linting checks, via a GitHub Action, 
on all PRs in the main Flink repository.

Often when a user submits a PR they will wait for the CI to run in Azure DevOps 
and this will fail as they have forgotten to run spotless or checkstyle. 
However, in order to find this out, the author has to dig through the Azure 
DevOps UI and often parse the logs.

We currently have a GitHub Action for running "pre-compile" checks that include 
all the standard linting checks: 
.github/workflows/template.pre-compile-checks.yml [1]. However this is only run 
as part of the nightly (beta) runs.

We have discussed, in the CHI meetings, how it would be a better experience for 
developers if this was run for every PR (using the default JVM, currently 17). 
That way a clear indication would be given, via the GitHub UI (green ticks and 
red crosses), if the PR has passed the basic checks or not.

This would hopefully speed up the review process.

I have raised a JIRA for this [2] and, initially, this would probably just 
consist of calling the pre-compile checks workflow as is from a top level PR 
check workflow. We could then add any further checks we identify in the future 
to that workflow.

Let me know what you think?

Cheers,

Tom Cooper
@tomcooper.dev | https://tomcooper.dev

[1] 
https://github.com/apache/flink/blob/master/.github/workflows/template.pre-compile-checks.yml
[2] https://issues.apache.org/jira/browse/FLINK-37534

Reply via email to