PULL-REQUEST-CHECKS-CONFIG.md

Pull request checks configuration

Properties

• codespell (object): The codespell check configuration.
  • internal-dictionaries (array): List of argument that will be added to the codespell command. Default: ["clear", "rare", "informal", "code", "names", "en-GB_to_en-US"].
    • Items (string)
  • arguments (array): List of argument that will be added to the codespell command. Default: ["--quiet-level=2", "--check-filenames", "--ignore-words-list=ro"].
    • Items (string)
  • ignore-re (array): List of regular expression that should be ignored. Default: ["(.*/)?poetry\\.lock", "(.*/)?package-lock\\.json"].
    • Items (string)
• commits-messages: Check the pull request commits messages.
  • One of
    • object: The commit message check configuration.
      • check-fixup (boolean): Check that we don't have one fixup commit in the pull request. Default: true.
      • check-squash (boolean): Check that we don't have one squash commit in the pull request. Default: true.
      • check-first-capital (boolean): Check that the all the commits message starts with a capital letter. Default: true.
      • min-head-length (integer): Check that the commits message head is at least this long, use 0 to disable. Default: 5.
      • check-no-merge-commits (boolean): Check that we don't have merge commits in the pull request. Default: true.
      • check-no-own-revert (boolean): Check that we don't have reverted one of our commits in the pull request. Default: true.
    • boolean
• commits-spell
  • One of
    • object: Configuration used to check the spelling of the commits.
      • only-head (boolean): Default: true.
    • boolean
• pull-request-spell
  • One of
    • object: Configuration used to check the spelling of the title and body of the pull request.
      • only-head (boolean): Default: true.
    • boolean