Public APIs

Import pygithub_mate:

import pygithub_mate.api as pygithub_mate

Core Classes:

• BaseLogger: Base logging functionality with configurable output control.

• BaseGitHubApiRunner: Base class for GitHub API operations with authentication and logging.

• BaseGitHubRepo: Main class for GitHub repository operations.

Data Containers:

• TagAndRef: Container for Git tag and reference objects.

• ReleaseAndTagAndRef: Container for GitHub release, tag, and reference objects.

• IsTagLatestOnDefaultBranchResult: Result container for tag currency checks.

Repository Information:

• BaseGitHubRepo.repo_full_name: Full repository name in owner/repo format.

• BaseGitHubRepo.repo: GitHub repository object.

• BaseGitHubRepo.repo_default_branch_name: Default branch name.

Commit Operations:

• BaseGitHubRepo.get_latest_commit_sha_on_branch: Get latest commit SHA on specified branch.

• BaseGitHubRepo.get_latest_commit_sha_on_default_branch: Get latest commit SHA on default branch.

• BaseGitHubRepo.latest_commit_sha_on_default_branch: Cached latest commit SHA on default branch.

Tag Operations:

• BaseGitHubRepo.get_git_tag_and_ref: Retrieve Git tag and reference objects.

• BaseGitHubRepo.is_tag_latest_on_default_branch: Check if tag points to latest commit on default branch.

• BaseGitHubRepo.delete_tag: Delete existing Git tag reference.

• BaseGitHubRepo.create_tag_on_commit: Create new Git tag on specific commit.

• BaseGitHubRepo.create_tag_on_latest_commit_on_default_branch: Create new Git tag on latest commit of default branch.

• BaseGitHubRepo.put_tag_on_commit: Ensure Git tag points to specific commit with intelligent workflow.

• BaseGitHubRepo.put_tag_on_latest_commit_on_branch: Ensure Git tag points to latest commit on specified branch.

• BaseGitHubRepo.put_tag_on_latest_commit_on_default_branch: Ensure Git tag points to latest commit on default branch.

Release Operations:

• BaseGitHubRepo.get_git_release: Retrieve GitHub release object.

• BaseGitHubRepo.delete_release: Delete existing GitHub release.

• BaseGitHubRepo.create_release: Create new GitHub release.

• BaseGitHubRepo.put_release: Ensure GitHub release and tag point to specific commit with comprehensive workflow.

• BaseGitHubRepo.put_release_on_latest_commit_on_branch: Ensure GitHub release and tag point to latest commit on specified branch.

• BaseGitHubRepo.put_release_on_latest_commit_on_default_branch: Ensure GitHub release and tag point to latest commit on default branch.

• BaseGitHubRepo.put_assets_to_release: Upload assets to release with intelligent duplicate handling.

Utilities:

• Emoji: Emoji constants for logging and display.

• BaseLogger.info: Log informational messages with verbosity control.

• BaseLogger.shorten_sha: Shorten Git SHA for display purposes.