repomatic.github package

GitHub integration package: API clients, gh CLI wrapper, and helpers for every GitHub surface repomatic touches (releases, issues, PRs, tokens, workflows). See each submodule’s docstring for its scope.

Submodules

• repomatic.github.actions module
  • NULL_SHA
  • MAX_STEP_OUTPUT_BYTES
  • RUN_LISTING_WINDOW
  • WorkflowEvent
    • WorkflowEvent.branch_protection_rule
    • WorkflowEvent.check_run
    • WorkflowEvent.check_suite
    • WorkflowEvent.create
    • WorkflowEvent.delete
    • WorkflowEvent.deployment
    • WorkflowEvent.deployment_status
    • WorkflowEvent.discussion
    • WorkflowEvent.discussion_comment
    • WorkflowEvent.fork
    • WorkflowEvent.gollum
    • WorkflowEvent.issue_comment
    • WorkflowEvent.issues
    • WorkflowEvent.label
    • WorkflowEvent.merge_group
    • WorkflowEvent.milestone
    • WorkflowEvent.page_build
    • WorkflowEvent.project
    • WorkflowEvent.project_card
    • WorkflowEvent.project_column
    • WorkflowEvent.public
    • WorkflowEvent.pull_request
    • WorkflowEvent.pull_request_comment
    • WorkflowEvent.pull_request_review
    • WorkflowEvent.pull_request_review_comment
    • WorkflowEvent.pull_request_target
    • WorkflowEvent.push
    • WorkflowEvent.registry_package
    • WorkflowEvent.release
    • WorkflowEvent.repository_dispatch
    • WorkflowEvent.schedule
    • WorkflowEvent.status
    • WorkflowEvent.watch
    • WorkflowEvent.workflow_call
    • WorkflowEvent.workflow_dispatch
    • WorkflowEvent.workflow_run
  • AnnotationLevel
    • AnnotationLevel.ERROR
    • AnnotationLevel.WARNING
    • AnnotationLevel.NOTICE
  • ReportAction
    • ReportAction.DROPPED
    • ReportAction.DRY_RUN
    • ReportAction.FAILED
    • ReportAction.SKIPPED
    • ReportAction.UNSUBSCRIBED
    • ReportAction.UPDATED
    • ReportAction.UPLOADED
  • extract_workflow_filename()
  • generate_delimiter()
  • trim_to_budget()
  • trim_to_byte_budget()
  • format_multiline_output()
  • write_output_file()
  • format_file_output()
  • emit_report()
  • read_file_output()
  • emit_annotation()
  • get_github_event()
  • get_event_pull_request()
  • get_event_subject()
  • get_default_author()
  • get_default_number()
  • is_pull_request()
  • runs_created_since()
  • workflow_runs()
  • cancel_superseded_runs()
• repomatic.github.ci_status module
  • TIP_HISTORY_DEPTH
  • STABLE_GLYPH
  • UNSTABLE_GLYPH
  • TERMINAL_STATUSES
  • CI_STATUS_HEADER_DEFS
  • JobStatus
    • JobStatus.name
    • JobStatus.status
    • JobStatus.conclusion
    • JobStatus.required
    • JobStatus.failed
    • JobStatus.running
  • RunStatus
    • RunStatus.workflow
    • RunStatus.run_id
    • RunStatus.head_sha
    • RunStatus.status
    • RunStatus.conclusion
    • RunStatus.jobs
    • RunStatus.failed_required
    • RunStatus.failed_probes
    • RunStatus.running_jobs
    • RunStatus.workflow_level_failure
    • RunStatus.blocking
    • RunStatus.verdict
  • CIStatus
    • CIStatus.branch
    • CIStatus.tip_sha
    • CIStatus.runs
    • CIStatus.blocking
    • CIStatus.runs_on_tip
    • CIStatus.settled
  • workflow_files()
  • monitored_workflows()
  • latest_run()
  • read_ci_status()
• repomatic.github.dev_release module
  • DEV_ASSET_PATTERNS
  • sync_dev_release()
  • upload_release_assets()
  • cleanup_dev_releases()
  • delete_release_by_tag()
• repomatic.github.gh module
  • gh_executable()
  • resolve_gh_token()
  • api_headers()
  • gh_env()
  • run_gh_command()
  • parse_create_output()
  • gh_api_json()
  • gh_graphql()
  • iter_graphql_nodes()
• repomatic.github.issue module
  • BOT_ISSUE_LABEL
  • LOCKED_CONVERSATION_MARKER
  • LOCK_INACTIVE_DAYS
  • LOCK_ISSUE_COMMENT
  • LOCK_PR_COMMENT
  • LOCK_REASON
  • LOCK_THREADS_HEADER_DEFS
  • LOCK_SEARCH_LIMIT
  • add_labels()
  • search_stale_threads()
  • lock_thread()
  • lock_stale_threads()
  • list_issues()
  • unlock_thread()
  • run_unlocking()
  • close_issue()
  • reopen_issue()
  • create_issue()
  • update_issue()
  • triage_issues()
  • manage_issue_lifecycle()
• repomatic.github.job_timings module
  • UNATTRIBUTED
  • JOB_TIMINGS_HEADER_DEFS
  • JobTiming
    • JobTiming.name
    • JobTiming.runner
    • JobTiming.seconds
  • match_runner()
  • fetch_job_timings()
  • RunnerReport
    • RunnerReport.runner
    • RunnerReport.job_count
    • RunnerReport.median_seconds
    • RunnerReport.slowest_job
    • RunnerReport.slowest_seconds
  • summarize()
  • format_duration()
  • render_markdown()
• repomatic.github.matrix module
  • JOB_STATE_KEY
  • OS_AXIS
  • PYTHON_VERSION_AXIS
  • PIVOT_CELL_SEPARATOR
  • RESERVED_MATRIX_KEYWORDS
  • stale_axis_values()
  • Matrix
    • Matrix.variations
    • Matrix.include
    • Matrix.exclude
    • Matrix.matrix()
    • Matrix.add_variation()
    • Matrix.replace_variation_value()
    • Matrix.remove_variation_value()
    • Matrix.add_includes()
    • Matrix.add_excludes()
    • Matrix.prune()
    • Matrix.all_variations()
    • Matrix.product()
    • Matrix.solve()
    • Matrix.pivot_counts()
    • Matrix.pivot()
• repomatic.github.pr module
  • STALE_PR_COMMENT
  • TEMP_BRANCH_PREFIX
  • PrOperation
    • PrOperation.CREATED
    • PrOperation.UPDATED
    • PrOperation.CLOSED
    • PrOperation.NONE
  • PrSyncResult
    • PrSyncResult.operation
    • PrSyncResult.branch
    • PrSyncResult.number
    • PrSyncResult.url
  • list_open_prs_by_branch()
  • list_changed_files()
  • close_pr()
  • close_open_prs_on_branch()
  • carry_pr_branch_paths()
  • upsert_pr()
• repomatic.github.pr_body module
  • GITHUB_BODY_MAX_CHARS
  • sanitize_markdown_mentions()
  • demote_markdown_headings()
  • load_template()
  • footer_opted_out()
  • render_template()
  • render_title()
  • render_commit_message()
  • template_args()
  • template_labels()
  • template_draft()
  • template_docs_url()
  • template_stem()
  • get_template_names()
  • generate_pr_metadata_block()
  • generate_refresh_tip()
  • build_release_review_steps()
  • build_pr_body()
  • fit_github_body()
  • temp_body_file()
• repomatic.github.release_sync module
  • build_expected_body()
  • SyncRow
    • SyncRow.action
    • SyncRow.version
    • SyncRow.release_url
  • SyncResult
    • SyncResult.dry_run
    • SyncResult.rows
    • SyncResult.total
    • SyncResult.in_sync
    • SyncResult.drifted
    • SyncResult.updated
    • SyncResult.failed
    • SyncResult.missing_changelog
  • sync_github_releases()
  • render_sync_report()
• repomatic.github.releases module
  • GITHUB_API_RELEASES_URL
  • GITHUB_API_TAG_REF_URL
  • GITHUB_API_TAG_OBJECT_URL
  • GITHUB_API_RELEASE_BY_TAG_URL
  • owner_repo()
  • GitHubReleasesUnavailable
  • GitHubRelease
    • GitHubRelease.date
    • GitHubRelease.body
  • ReleaseAsset
    • ReleaseAsset.name
    • ReleaseAsset.size
    • ReleaseAsset.sha256
    • ReleaseAsset.download_url
  • ReleaseWithAssets
    • ReleaseWithAssets.tag
    • ReleaseWithAssets.date
    • ReleaseWithAssets.draft
    • ReleaseWithAssets.prerelease
    • ReleaseWithAssets.assets
    • ReleaseWithAssets.body
    • ReleaseWithAssets.html_url
  • get_github_releases()
  • get_release_tags()
  • get_releases_with_assets()
  • parse_release_version()
  • dev_release_url_and_previous_version()
  • resolve_tag_to_sha()
  • extract_version()
  • edit_release_notes()
  • get_github_release_body()
  • fetch_github_release_notes()
• repomatic.github.sponsor module
  • get_default_owner()
  • SPONSORS_QUERY_TEMPLATE
  • get_sponsors()
  • is_sponsor()
• repomatic.github.status module
  • GITHUB_STATUS_SUMMARY_URL
  • GitHubStatus
    • GitHubStatus.indicator
    • GitHubStatus.description
    • GitHubStatus.is_incident
    • GitHubStatus.annotation()
  • get_github_status()
  • status_annotation()
  • with_status_annotation()
• repomatic.github.token module
  • require_token()
  • PatProbe
    • PatProbe.field
    • PatProbe.permission
    • PatProbe.endpoint
    • PatProbe.success
    • PatProbe.not_found
  • PAT_PERMISSION_PROBES
  • probe_pat_permission()
  • PatPermissionResults
    • PatPermissionResults.administration
    • PatPermissionResults.contents
    • PatPermissionResults.issues
    • PatPermissionResults.pull_requests
    • PatPermissionResults.vulnerability_alerts
    • PatPermissionResults.workflows
    • PatPermissionResults.iter_results()
    • PatPermissionResults.failed()
  • check_all_pat_permissions()
  • validate_gh_token_env()
  • validate_gh_api_access()
  • validate_classic_pat_scope()
• repomatic.github.unsubscribe module
  • GRAPHQL_PAGE_SIZE
  • NOTIFICATION_PAGE_SIZE
  • NOTIFICATION_SUBJECT_TYPES
  • SUBJECT_BATCH_SIZE
  • SUBJECT_STATES
  • SUBJECT_URL_PATTERN
  • UNSUBSCRIBE_WORKFLOW
  • DetailRow
    • DetailRow.action
    • DetailRow.html_url
    • DetailRow.number
    • DetailRow.repo
    • DetailRow.title
    • DetailRow.updated_at
  • Phase1Result
    • Phase1Result.cutoff
    • Phase1Result.max_unsubscribes
    • Phase1Result.newest_updated
    • Phase1Result.oldest_updated
    • Phase1Result.rows
    • Phase1Result.threads_deferred
    • Phase1Result.threads_failed
    • Phase1Result.threads_skipped_open
    • Phase1Result.threads_skipped_recent
    • Phase1Result.threads_skipped_unknown
    • Phase1Result.threads_total
    • Phase1Result.threads_unsubscribed
  • Phase2Result
    • Phase2Result.cutoff
    • Phase2Result.items_deferred
    • Phase2Result.items_failed
    • Phase2Result.items_not_subscribed
    • Phase2Result.items_skipped_recent
    • Phase2Result.items_total
    • Phase2Result.items_unsubscribed
    • Phase2Result.max_unsubscribes
    • Phase2Result.rows
    • Phase2Result.search_query
    • Phase2Result.skipped
    • Phase2Result.skip_reason
  • UnsubscribeResult
    • UnsubscribeResult.dry_run
    • UnsubscribeResult.months
    • UnsubscribeResult.phase1
    • UnsubscribeResult.phase2
  • render_report()
  • unsubscribe_threads()
• repomatic.github.workflow_sync module
  • CALLER_INPUT_DEFAULTS
  • COOLDOWN_DOCS_URL
  • cooldown_env_block()
  • PERMISSION_RANK
  • DEFAULT_VERSION
  • WorkflowTriggerInfo
    • WorkflowTriggerInfo.name
    • WorkflowTriggerInfo.filename
    • WorkflowTriggerInfo.non_call_triggers
    • WorkflowTriggerInfo.call_inputs
    • WorkflowTriggerInfo.call_secrets
    • WorkflowTriggerInfo.has_workflow_call
    • WorkflowTriggerInfo.concurrency
    • WorkflowTriggerInfo.raw_concurrency
  • LintResult
    • LintResult.message
    • LintResult.is_issue
    • LintResult.level
  • workflow_triggers()
  • canonical_caller_permissions()
  • extract_trigger_info()
  • PathsSpec
    • PathsSpec.source_paths
    • PathsSpec.extra_paths
    • PathsSpec.ignore_paths
    • PathsSpec.workflow_paths
  • generate_thin_caller()
  • EXTRA_JOBS_SEPARATOR
  • render_thin_caller_for_target()
  • GENERATED_CALLER_JOBS
  • identify_canonical_workflow()
  • extract_extra_jobs()
  • extras_define_jobs()
  • check_has_workflow_dispatch()
  • check_version_pinned()
  • check_triggers_match()
  • check_secrets_passed()
  • generate_workflow_header()
  • run_workflow_lint()