.commitlintrc.yml

# Copyright (C) 2023 The ORT Server Authors (See <https://github.com/eclipse-apoapsis/ort-server/blob/main/NOTICE>)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# License-Filename: LICENSE

# Commitlint configuration.
# See: https://github.com/conventional-changelog/commitlint/blob/master/docs/reference-rules.md
---
parserPreset:
  parserOpts:
    headerPattern: '^(\w*)(?:\((.*)\))?!?: (.*)$'
    breakingHeaderPattern: '^(\w*)(?:\((.*)\))?!: (.*)$'
    headerCorrespondence: ['type', 'scope', 'subject']
    noteKeywords: ['BREAKING CHANGE', 'BREAKING-CHANGE', '\[\d+\]:', 'Signed-off-by:']
    revertPattern: '/^(?:Revert|revert:)\s"?([\s\S]+?)"?\s*This reverts commit (\w*)\./i'
    revertCorrespondence: ['header', 'hash']
rules:
  body-leading-blank:
    - 2
    - always
  body-max-line-length:
    - 2
    - always
    - 75
  footer-leading-blank:
    - 2
    - always
  header-max-length:
    - 2
    - always
    - 75
  scope-case:
    - 0
  subject-case:
    - 1
    - always
    - - pascal-case
      - sentence-case
      - start-case
      - upper-case
  subject-empty:
    - 2
    - never
  subject-full-stop:
    - 2
    - never
    - .
  type-case:
    - 2
    - always
    - lower-case
  type-empty:
    - 2
    - never
  type-enum:
    - 2
    - always
    - - build
      - chore
      - ci
      - deps
      - docs
      - feat
      - fix
      - perf
      - refactor
      - revert
      - style
      - test
  signed-off-by:
    - 2
    - always