update_history

Generate release notes and prepend them to HISTORY.md.

def update_history(
    new_version: string,
    dry_run: boolean,
    force_update: boolean
) - > None

Generate release notes and prepend them to HISTORY.md.

Parameters

Name	Type	Description
new_version	string	The semantic version string to be used for the new release entry and citation metadata.
dry_run	boolean	If true, prints the proposed changes to the console instead of writing them to the file system.
force_update	boolean	If true, allows the function to overwrite or duplicate an existing version entry in the history file without issuing a warning.

Returns

Type	Description
	Nothing is returned; the function performs file I/O to update project documentation.