devops.files.update_changelog

Module for updating the changelog file.

Functions

update_changelog(version, changelog_path)

Update the changelog file with a new version entry.

Exceptions

DevOpsChangelogError(message)

Base class for changelog related errors.

exception devops.files.update_changelog.DevOpsChangelogError(message)

Bases: Exception

Base class for changelog related errors.

Parameters:

message (str)

Return type:

None

devops.files.update_changelog.update_changelog(version, changelog_path)

Update the changelog file with a new version entry.

Parameters:

• version (str) – The new version to add to the changelog.

• changelog_path (Path) – The path to the changelog file.

Raises:

• DevOpsFileNotFoundError – If the changelog file does not exist. Happens inside open_file.

• DevOpsChangelogError – If the “## Next Release” marker is not found in the changelog.

Return type:

None