Module: GitHub — Homebrew Ruby API
Index (G) » GitHub Module: GitHub Private Extended by: Workflows , SystemCommand::Mixin , Utils::Output::Mixin Defined in: utils/github.rb , utils/github/api.rb, utils/github/actions.rb, utils/github/artifacts.rb, utils/github/workflows.rb, utils/github/patch_inclusion.rb This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Defined Under Namespace Modules: API , Actions , Workflows Classes: PatchInclusion Constant Summary collapse MAX_PER_PAGE = This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew , except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 100 WorkflowArray = This constant is part of an internal API.
This constant may only be used internally in repositories owned by Homebrew , except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. T . type_alias { [ T :: Array [ T :: Hash [ String , T . untyped ] ] , String , String , String , String , T :: Array [ String ] , String ] } MAXIMUM_OPEN_PRS = This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew , except in casks or formulae.
Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 15 API_URL = This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew , except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. " https://api.github.com " CREATE_GIST_SCOPES = This constant is part of an internal API.
This constant may only be used internally in repositories owned by Homebrew , except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. [ " gist " ] . freeze CREATE_ISSUE_FORK_OR_PR_SCOPES = This constant is part of an internal API. This constant may only be used internally in repositories owned by Homebrew , except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. [ " repo " ] . freeze CREATE_WORKFLOW_SCOPES = This constant is part of an internal API.
This constant may only be used internally in repositories owned by Homebrew , except in casks or formulae. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. [ " workflow " ] . freeze Class Method Summary collapse . check_for_duplicate_pull_requests (name, tap_remote_repo, file:, quiet: false, state: nil, version: nil, official_tap: true, strict: false) ⇒ void internal Check for duplicate pull requests that modify the same file. . create_fork (repo, org: nil) ⇒ Hash{String => T.untyped} private . create_gist (files, description, private:) ⇒ String private . create_issue (repo, title, body) ⇒ String private . create_issue_comment (repo, issue, body) ⇒ Hash{String => T.untyped} private . create_or_update_release (user, repo, tag, id: nil, name: nil, body: nil, draft: false) ⇒ Hash{String => T.untyped} private . create_pull_request (repo, title, head, base, body) ⇒ Hash{String => T.untyped} private . download_artifact (url, artifact_id) ⇒ void private Download an artifact from GitHub Actions and unpack it into the current working directory. . fetch_open_pull_requests (name, tap_remote_repo, version: nil) ⇒ Array<Hash{String => String}> private . fetch_pull_requests (name, tap_remote_repo, state: nil, version: nil) ⇒ Array<Hash{String => T.untyped}> private . fork_exists? (repo, org: nil) ⇒ Boolean private . generate_release_notes (user, repo, tag, previous_tag: nil) ⇒ Hash{String => T.untyped} private . get_draft_release (user, repo, tag) ⇒ Hash{String => T.untyped} ? private . get_latest_release (user, repo) ⇒ Hash{String => T.untyped} private . get_pull_request_changed_files (tap_remote_repo, pull_request) ⇒ Array<T.untyped> private . get_release (user, repo, tag) ⇒ Hash{String => T.untyped} private . get_repo_license (user, repo, ref: nil) ⇒ String ? private . issues (repo:, **filters) ⇒ Array<Hash{String => T.untyped}> private . issues_for_formula (name, tap: CoreTap.instance, tap_remote_repo: tap&.full_name, state: nil, type: nil) ⇒ Array<Hash{String => T.untyped}> private . last_commit (user, repo, ref, version, length: nil) ⇒ String ? private . members_by_team (org, team) ⇒ Hash{String => String} private . multiple_short_commits_exist? (user, repo, commit) ⇒ Boolean private . organisation_repositories (organisation, from, to, verbose) ⇒ Array<String> private . pat_blurb (scopes = ALL_SCOPES) ⇒ String private . print_pull_requests_matching (query, only = nil) ⇒ void private . private_repo? (full_name) ⇒ Boolean private We default to private if we aren't sure or if the GitHub API is disabled. . pull_request_commits (user, repo, pull_request, per_page: MAX_PER_PAGE) ⇒ Array<String> private . pull_request_labels (user, repo, pull_request) ⇒ Array<String> private . pull_request_title_regex (name, version = nil) ⇒ Regexp private . repository (user, repo) ⇒ Hash{String => T.untyped} private . repository_approved_reviews (user, repo, pull_request, commit: nil) ⇒ Array<Hash{String => T.untyped}> private . search (entity, *queries, **qualifiers) ⇒ Hash{String => T.untyped} private . search_approved_pull_requests_in_user_or_organisation (user, reviewed_by, from:, to:) ⇒ Array<Hash{String => T.untyped}> private . search_issues (query, **qualifiers) ⇒ Array<Hash{String => T.untyped}> private . search_query_string (*main_params, **qualifiers) ⇒ String private . sponsorship_tiers (user) ⇒ Array<Hash> private Return published tiers with one-time prices expressed as monthly amounts. . sponsorships (user) ⇒ Array<Hash> private . too_many_open_prs? (tap) ⇒ Boolean private . upload_release_asset (user, repo, id, local_file:, remote_file: nil) ⇒ void private . url_to (*subroutes) ⇒ URI::Generic private . user ⇒ Hash{String => T.untyped} private . workflow_dispatch_event (user, repo, workflow, ref, **inputs) ⇒ void private Methods included from Workflows get_artifact_urls , get_workflow_run Methods included from SystemCommand::Mixin command_sandbox , system_command , system_command!
Methods included from Utils::Output::Mixin issue_reporting_message , odebug , odeprecated , odie , odisabled , ofail , oh1 , oh1_title , ohai , ohai_title , onoe , opoo , opoo_once , opoo_outside_github_actions , opoo_without_github_actions_annotation , pretty_cannot_install , pretty_deprecated , pretty_disabled , pretty_duration , pretty_install_status , pretty_installed , pretty_removed , pretty_uninstalled , pretty_unmarked , pretty_upgradable , pretty_warning Class Method Details . check_for_duplicate_pull_requests (name, tap_remote_repo, file:, quiet: false, state: nil, version: nil, official_tap: true, strict: false) ⇒ void This method is part of an internal API.
This method may only be used internally in repositories owned by Homebrew , except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning. This method returns an undefined value. Check for duplicate pull requests that modify the same file. Exits the process on duplicates if strict or both version and official_tap , otherwise warns. Parameters: name ( String ) tap_remote_repo ( String ) file ( String ) quiet ( Boolean ) (defaults to: false ) state ( String , nil ) (defaults to: nil ) version ( String , nil ) (defaults to: nil ) official_tap ( Boolean ) (defaults to: true ) strict ( Boolean ) (defaults to: false ) 582 583
The rest of this page is on the live site.