semantic_release.history.logs module¶
Logs
- semantic_release.history.logs.evaluate_version_bump(current_version: str, force: str = None) Optional[str] [source]¶
Read git log since the last release to decide if we should make a major, minor or patch release.
- Parameters:
current_version – A string with the current version number.
force – A string with the bump level that should be forced.
- Returns:
A string with either major, minor or patch if there should be a release. If no release is necessary, None will be returned.
- semantic_release.history.logs.generate_changelog(from_version: Optional[str], to_version: Optional[str] = None) dict [source]¶
Parse a changelog dictionary for the given version.
- Parameters:
from_version – The version before where the changelog starts. The changelog will be generated from the commit after this one.
to_version – The last version included in the changelog.
- Returns:
A dict with changelog sections and commits