Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-28969

Lint All Possible Files

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: QualifiedToSchedule
    • Component/s: CI/CD

      Description

      Context

      Currently, a lot of our time passed to review a PR is to check the format and the style of changed files.

      The concerned formats are: md, yaml, Dockerfile, java...

      Each format has a different tool and mechanism to check the format and style.
      For instance, for java files we want to leverage sonar cloud for such analysis whereas we want to use markdownlint for md files. The second one could be done during the pre-commit phase whereas we need a long analysis for sonar.

      Request

      We want to include a lint stage in our CI builds. We want to have this logic on several repositories, so the stage should call prepared scripts which basically sets a pending status, runs the linter, and sets a success/failure status.

      Linter configuration should be included in the builder images, and if possible overridable by the repository.

      We may also want to have a mechanism to run the same thing locally. Depending on the tools we may want to run the linter during the pre-commit phase or leverage maven to run the linter.

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              kleturc Kevin Leturc
              Participants:
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: