2.3.3.5.3. Commits¶
Relative Filepath[1]:
dev/commit.yamlPre-configured: True
[1]: Filepath is relative to the root of the control center directory.
$schema: https://json-schema.org/draft/2020-12/schema
title: Commit Configurations
description: Commit types, sub-types and descriptions
type: object
default: {}
additionalProperties: false
properties:
primary_action:
description: Primary action commit types
type: object
default: {}
additionalProperties: false
properties:
release_major:
type: object
default: { }
additionalProperties: false
properties:
type:
type: string
default: major
description:
type: string
default: |
Remove features/components from - or introduce breaking changes to - the public API,
and publish a new major release of the package.
subtypes:
$ref: '#/definitions/subtypes'
required: [ type, description ]
release_minor:
type: object
default: { }
additionalProperties: false
properties:
type:
type: string
default: minor
description:
type: string
default: |
Add features/components to - or enhance/deprecate existing features in - the public API,
and publish a new minor release of the package.
subtypes:
$ref: '#/definitions/subtypes'
required: [ type, description ]
release_patch:
type: object
default: { }
additionalProperties: false
properties:
type:
type: string
default: patch
description:
type: string
default: |
Fix bugs or security issues in the public API,
or improve the performance of existing functionalities,
and publish a new patch release of the package.
subtypes:
$ref: '#/definitions/subtypes'
required: [ type, description ]
release_post:
type: object
default: { }
additionalProperties: false
properties:
type:
type: string
default: post
description:
type: string
default: |
Fix documentation or release notes in a previous package release,
and publish a new post release.
subtypes:
$ref: '#/definitions/subtypes'
required: [ type, description ]
website:
type: object
default: {}
additionalProperties: false
properties:
type:
type: string
default: web
description:
type: string
default: Change the website content, design or backend.
subtypes:
$ref: '#/definitions/subtypes'
announcement:
type: object
default: {}
additionalProperties: false
properties:
scope:
type: string
default: ""
changelog_id:
type: string
default: ""
changelog_section_id:
type: string
default: ""
required: [ scope, changelog_id, changelog_section_id ]
required: [ type, description, announcement ]
meta:
type: object
default: { }
additionalProperties: false
properties:
type:
type: string
default: meta
description:
type: string
default: |
Change the meta content of the repository.
subtypes:
$ref: '#/definitions/subtypes'
required: [ type, description ]
required:
- release_major
- release_minor
- release_patch
- release_post
- website
- meta
primary_custom:
type: object
default: {}
additionalProperties:
type: object
additionalProperties: false
properties:
type:
type: string
description:
type: string
subtypes:
$ref: '#/definitions/subtypes'
required: [ type, description ]
secondary_action:
description: Secondary action commit types
type: object
default: { }
properties:
auto-update:
type: object
default: { }
additionalProperties: false
properties:
type:
type: string
default: auto-update
description:
type: string
default: |
Automatically update the repository contents.
required: [ type, description ]
meta_sync:
type: object
default: {}
additionalProperties: false
properties:
type:
type: string
default: meta-update
description:
type: string
default: |
Update the dynamic files of the repository.
required: [ type, description ]
revert:
type: object
default: { }
additionalProperties: false
properties:
type:
type: string
default: revert
description:
type: string
default: |
Revert a previous commit.
hook_fix:
type: object
default: { }
additionalProperties: false
properties:
type:
type: string
default: auto-refactor
description:
type: string
default: |
Automatically refactor the code.
required: [ auto-update, meta_sync, revert, hook_fix ]
secondary_custom:
description: Secondary commit types
type: object
default: {}
additionalProperties:
type: object
additionalProperties: false
properties:
description:
type: string
changelog_id:
type: string
changelog_section_id:
type: string
required: [ description, changelog_id, changelog_section_id ]
required: [ primary_action, primary_custom, secondary_action, secondary_custom ]
definitions:
subtypes:
type: object
properties:
any:
type: array
items:
type: string
minItems: 1
uniqueItems: true
all:
type: array
items:
type: string
minItems: 1
uniqueItems: true
include:
type: array
items:
type: string
minItems: 1
uniqueItems: true
exclude:
type: array
items:
type: string
minItems: 1
uniqueItems: true
allOf:
- anyOf:
- required: [ any ]
- required: [ all ]
- not:
anyOf:
- required: [ include, exclude ]
primary_action:
release_major:
type: major
description: "Remove features/components from - or introduce breaking changes
to - the public API, \nand publish a new major release of the package.\n"
release_minor:
type: minor
description: "Add features/components to - or enhance/deprecate existing features
in - the public API, \nand publish a new minor release of the package.\n"
release_patch:
type: patch
description: "Fix bugs or security issues in the public API, \nor improve the
performance of existing functionalities, \nand publish a new patch release of
the package.\n"
release_post:
type: post
description: "Fix documentation or release notes in a previous package release,
\nand publish a new post release.\n"
website:
type: web
description: Change the website content, design or backend.
announcement:
scope: ''
changelog_id: ''
changelog_section_id: ''
meta:
type: meta
description: "Change the meta content of the repository.\n"
primary_custom: {}
secondary_action:
auto-update:
type: auto-update
description: "Automatically update the repository contents.\n"
meta_sync:
type: meta-update
description: "Update the dynamic files of the repository.\n"
revert:
type: revert
description: "Revert a previous commit.\n"
hook_fix:
type: auto-refactor
description: "Automatically refactor the code.\n"
secondary_custom: {}