action_utils.check_version module

Assert repo version was bumped if a git diff implies it should have been

action_utils.check_version.file_is_relevant(file_name: str, includes: Optional[list[str]] = None, excludes: Optional[list[str]] = None) → bool

Helper method that determines if a given file name is relevant for the check

Parameters:

  • file_name – The name of the file to check

  • includes – List of paths/patterns to be checked

  • excludes – List of paths/patterns to be excluded from the check, taking priority over includes

action_utils.check_version.main()

Main entrypoint

action_utils.check_version.missing_version_bump(repo: github.Repository.Repository, pull: github.PullRequest.PullRequest, version: VersionTag, includes: Optional[list[str]] = None, excludes: Optional[list[str]] = None) → bool

Determines if a pull request should have incurred a version bump, and if so asserts that the version was bumped

Parameters:

  • repo – PyGithub Repository instance

  • pull – PyGithub PullRequest instance

  • version – Version parsed from repo data JSON file

  • includes – List of paths/patterns that when changed should incur a version bump

  • excludes – List of paths/patterns that do not matter for version bumping - takes priority over includes

Returns:

True if a version bump is required but was not made, False otherwise

action_utils.check_version.parse_args()

Parse commandline args