Skip to content

Latest commit

 

History

History
42 lines (40 loc) · 2.81 KB

CHANGELOG-CONFIG.md

File metadata and controls

42 lines (40 loc) · 2.81 KB
Raw

Changelog configuration Base

Properties

  • changelog (object): The changelog generation configuration. Cannot contain additional properties.
    • create-labels (boolean): Automatically create the labels used in the changelog configuration. Default: false.
    • create-release (boolean): Create a release based on the tag. Default: true.
    • labels (object): The labels configuration. Can contain additional properties.
      • Additional properties (object): The label configuration.
        • description (string): The description of the label.
        • color (string): The color of the label.
    • sections (array): The sections configuration.
      • Items (object): The section configuration.
        • name (string): The name of the section.
        • title (string): The title of the section.
        • description (string): The description of the section.
        • closed (boolean): The section is closed and openable. Default: false.
    • default-section (string): The default section for items.
    • routing (array): The routing configuration.
      • Items (object): The routing configuration.
        • section (string): The section section affected to changelog items that match with the conditions.
        • name (string): The name of the routing condition.
        • condition (object): The condition to match with the changelog items. Cannot contain additional properties.
          • One of
              • type (string): The type of the condition. Must be: "const".
              • value (boolean): The value of the condition.
              • type (string): The type of the condition. Must be one of: ["and", "or"].
              • conditions (array): The value of the conditions.
                • Items
              • type (string): The type of the condition. Must be one of: ["not"].
              • condition
              • type (string): The type of the condition. Must be: "label".
              • value (string): The value of the label.
              • type (string): The type of the condition. Must be: "files".
              • regex (array): The list of regex that all the files should match.
                • Items (string): The regex that all the files should match.
              • type (string): The type of the condition. Must be: "author".
              • value (string): The value of the author.
              • type (string): The type of the condition. Must be: "title".
              • regex (string): The regex the the title should match.
              • type (string): The type of the condition. Must be: "branch".
              • regex (string): The regex the the title should match.