mafw.scripts.update_changelog

Module provides a simplified script to perform MAFw changelog update using auto-changelog. It can be used as pre-commit entry point and also in CI.

The basic idea is that this command is invoking the auto-changelog tool to generate a temporary changelog. The checksum of the temporary changelog is compared with the existing one. If the two checksums differs, the current changelog is replaced with the newly created version.

When committing the changelog update please use mute as commit type, to avoid having a new changelog generated containing the changelog update commit.

Functions

`commit_changelog_changes`()	Commit the changes to CHANGELOG.md.
`get_last_commit_message`()	Get the message of the last commit.
`get_latest_tag`()	Get the latest git tag.
`main`()	Script entry point

mafw.scripts.update_changelog.commit_changelog_changes() → None[source]: Commit the changes to CHANGELOG.md.

mafw.scripts.update_changelog.get_last_commit_message() → str[source]

Get the message of the last commit.

Returns:: The last commit message
Return type:: str

mafw.scripts.update_changelog.get_latest_tag() → str[source]

Get the latest git tag.

Returns:: The last git tag.
Return type:: str

mafw.scripts.update_changelog.main() → None[source]: Script entry point