Skip to content

Auto-versioning context (av)

The av context can be used in templates in the PR title & body templates, in order to access information about the auto-versioning request.

Context: Auto-versioning

Fields

  • changelog: Changelog for the project & version being updated

    • allQualifiers - Boolean - required - Loop over all qualifiers for the last level of dependencies, including the default one. Qualifiers at dependencies take precedence.

    • commitsMaxLength - Int - required - Maximum length of a commit message in a change log, ellipsis included. Only the first line of a commit message is ever rendered; set this to 0 to render that line in full.

    • commitsOption - NONE, OPTIONAL, ALWAYS - required - Defines how to render commits for a change log

    • defaultQualifierFallback - Boolean - required - If a qualifier has no previous link, uses the default qualifier (empty) qualifier.

    • dependencies - List - required - Comma-separated list of project links to follow one by one for a get deep change log. Each item in the list is either a project name, or a project name and qualifier separated by a colon (:).

    • empty - String - required - String to use to render an empty or non existent change log

    • title - Boolean - required - Include a title for the change log

  • semanticChangelog: Semantic changelog (grouped by conventional commit type) for the project & version being updated

    • allQualifiers - Boolean - required - Loop over all qualifiers for the last level of dependencies, including the default one. Qualifiers at dependencies take precedence.

    • commitsMaxLength - Int - required - Maximum length of a commit message in a change log, ellipsis included. Only the first line of a commit message is ever rendered; set this to 0 to render that line in full.

    • defaultQualifierFallback - Boolean - required - If a qualifier has no previous link, uses the default qualifier (empty) qualifier.

    • dependencies - List - required - Comma-separated list of project links to follow one by one for a get deep change log. Each item in the list is either a project name, or a project name and qualifier separated by a colon (:).

    • emojis - Boolean - required - Use emojis in the section titles

    • exclude - List - required - Types to exclude

    • issues - Boolean - required - Must a section for changelog actual issues be present?

    • sections - List - required - Mapping types to section titles