check_yaml_changelog

Summary

check_yaml_changelog(descriptor: MapDescriptor) → str

Checks to ensure that a board’s .yaml descriptor file defines a changelog.

Parameters:

descriptor (MapDescriptor) – A MapDescriptor object representing a .yaml file.

Returns:

A string containing the error message if the check fails, or an empty string if it passes.

Return type:

str

Importing

from cs_board_tools.validation.board import check_yaml_changelog