From a721d1f6faa8d7ab8509eeb22ec8673d5315193c Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 8 Mar 2024 20:42:49 +0000 Subject: [PATCH] Update docs from Probot v13.0.2 via probot/probot@7583bdf29311d6cb9805844e20501166865d1408 --- _submodules/probot | 2 +- api/13.0.2/assets/highlight.css | 23 +++++-------- api/13.0.2/classes/context.Context.html | 34 +++++++++---------- .../manifest_creation.ManifestCreation.html | 4 +-- api/13.0.2/classes/probot.Probot.html | 4 +-- api/13.0.2/classes/server_server.Server.html | 4 +-- .../functions/apps_default.defaultApp.html | 2 +- .../functions/apps_setup.setupAppFactory.html | 2 +- api/13.0.2/functions/auth.auth.html | 4 +-- .../bin_read_cli_options.readCliOptions.html | 2 +- .../bin_read_env_options.readEnvOptions.html | 2 +- ..._node_middleware.createNodeMiddleware.html | 2 +- .../functions/create_probot.createProbot.html | 2 +- .../functions/get_router.getRouter.html | 2 +- ...ers_get_error_handler.getErrorHandler.html | 2 +- .../functions/helpers_get_log.getLog.html | 2 +- .../helpers_is_production.isProduction.html | 2 +- ...d_node_version.isSupportedNodeVersion.html | 2 +- ...ers_load_package_json.loadPackageJson.html | 2 +- .../helpers_rebind_log.rebindLog.html | 2 +- ...solve_app_function.resolveAppFunction.html | 2 +- ...pers_webhook_proxy.createWebhookProxy.html | 2 +- ...cated_octokit.getAuthenticatedOctokit.html | 2 +- ...tle_options.getOctokitThrottleOptions.html | 2 +- ...defaults.getProbotOctokitWithDefaults.html | 2 +- .../octokit_get_webhooks.getWebhooks.html | 2 +- ..._request_logging.probotRequestLogging.html | 2 +- ...t_webhooks_transform.webhookTransform.html | 2 +- api/13.0.2/functions/run.run.html | 2 +- ...gging_middleware.getLoggingMiddleware.html | 2 +- .../functions/views_import.importView.html | 2 +- .../functions/views_probot.probotView.html | 2 +- .../functions/views_setup.setupView.html | 2 +- .../functions/views_success.successView.html | 2 +- ...s_resolve_app_function.ResolveOptions.html | 4 +-- ...ers_webhook_proxy.WebhookProxyOptions.html | 4 +-- api/13.0.2/interfaces/types.Options.html | 4 +-- api/13.0.2/modules/apps_default.html | 2 +- api/13.0.2/modules/apps_setup.html | 2 +- api/13.0.2/modules/auth.html | 2 +- api/13.0.2/modules/bin_probot.html | 2 +- api/13.0.2/modules/bin_probot_receive.html | 2 +- api/13.0.2/modules/bin_probot_run.html | 2 +- api/13.0.2/modules/bin_read_cli_options.html | 2 +- api/13.0.2/modules/bin_read_env_options.html | 2 +- api/13.0.2/modules/context.html | 2 +- .../modules/create_node_middleware.html | 2 +- api/13.0.2/modules/create_probot.html | 2 +- api/13.0.2/modules/get_router.html | 2 +- .../modules/helpers_get_error_handler.html | 2 +- api/13.0.2/modules/helpers_get_log.html | 2 +- api/13.0.2/modules/helpers_is_production.html | 2 +- .../helpers_is_supported_node_version.html | 2 +- .../modules/helpers_load_package_json.html | 2 +- api/13.0.2/modules/helpers_rebind_log.html | 2 +- .../modules/helpers_resolve_app_function.html | 2 +- api/13.0.2/modules/helpers_webhook_proxy.html | 2 +- api/13.0.2/modules/index.html | 2 +- api/13.0.2/modules/manifest_creation.html | 2 +- .../octokit_get_authenticated_octokit.html | 2 +- .../octokit_get_octokit_throttle_options.html | 2 +- ...okit_get_probot_octokit_with_defaults.html | 2 +- api/13.0.2/modules/octokit_get_webhooks.html | 2 +- ...octokit_plugin_probot_request_logging.html | 2 +- .../octokit_octokit_webhooks_transform.html | 2 +- .../modules/octokit_probot_octokit.html | 2 +- api/13.0.2/modules/probot.html | 2 +- api/13.0.2/modules/run.html | 2 +- .../modules/server_logging_middleware.html | 2 +- api/13.0.2/modules/server_server.html | 2 +- api/13.0.2/modules/types.html | 2 +- api/13.0.2/modules/version.html | 2 +- api/13.0.2/modules/views_import.html | 2 +- api/13.0.2/modules/views_probot.html | 2 +- api/13.0.2/modules/views_setup.html | 2 +- api/13.0.2/modules/views_success.html | 2 +- api/13.0.2/types/context.MergeOptions.html | 2 +- .../types/helpers_get_log.GetLogOptions.html | 2 +- ...helpers_resolve_app_function.Resolver.html | 2 +- .../octokit_probot_octokit.ProbotOctokit.html | 2 +- api/13.0.2/types/probot.Constructor.html | 2 +- .../types/types.ApplicationFunction.html | 2 +- .../types.ApplicationFunctionOptions.html | 2 +- api/13.0.2/types/types.Env.html | 2 +- api/13.0.2/types/types.Manifest.html | 2 +- api/13.0.2/types/types.MiddlewareOptions.html | 2 +- api/13.0.2/types/types.OctokitOptions.html | 2 +- api/13.0.2/types/types.PackageJson.html | 2 +- api/13.0.2/types/types.ProbotWebhooks.html | 2 +- api/13.0.2/types/types.ServerOptions.html | 2 +- api/13.0.2/types/types.State.html | 2 +- ...ctokit_probot_octokit.ProbotOctokit-1.html | 2 +- .../server_server.defaultWebhooksPath.html | 2 +- api/13.0.2/variables/version.VERSION.html | 2 +- 94 files changed, 124 insertions(+), 131 deletions(-) diff --git a/_submodules/probot b/_submodules/probot index b93e73aab6b..7583bdf2931 160000 --- a/_submodules/probot +++ b/_submodules/probot @@ -1 +1 @@ -Subproject commit b93e73aab6bf14c3aa2649a6b3cd23164746eac6 +Subproject commit 7583bdf29311d6cb9805844e20501166865d1408 diff --git a/api/13.0.2/assets/highlight.css b/api/13.0.2/assets/highlight.css index b8721df66c1..e7d51e3188e 100644 --- a/api/13.0.2/assets/highlight.css +++ b/api/13.0.2/assets/highlight.css @@ -1,8 +1,8 @@ :root { --light-hl-0: #000000; --dark-hl-0: #D4D4D4; - --light-hl-1: #267F99; - --dark-hl-1: #4EC9B0; + --light-hl-1: #AF00DB; + --dark-hl-1: #C586C0; --light-hl-2: #001080; --dark-hl-2: #9CDCFE; --light-hl-3: #0000FF; @@ -13,14 +13,12 @@ --dark-hl-5: #CE9178; --light-hl-6: #0070C1; --dark-hl-6: #4FC1FF; - --light-hl-7: #AF00DB; - --dark-hl-7: #C586C0; - --light-hl-8: #800000; - --dark-hl-8: #569CD6; - --light-hl-9: #0000FF; - --dark-hl-9: #CE9178; - --light-hl-10: #008000; - --dark-hl-10: #6A9955; + --light-hl-7: #800000; + --dark-hl-7: #569CD6; + --light-hl-8: #0000FF; + --dark-hl-8: #CE9178; + --light-hl-9: #008000; + --dark-hl-9: #6A9955; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -36,7 +34,6 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } } @@ -51,7 +48,6 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } } @@ -66,7 +62,6 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } @@ -81,7 +76,6 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } @@ -95,5 +89,4 @@ .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } pre, code { background: var(--code-background); } diff --git a/api/13.0.2/classes/context.Context.html b/api/13.0.2/classes/context.Context.html index 6534726864f..34f86e45123 100644 --- a/api/13.0.2/classes/context.Context.html +++ b/api/13.0.2/classes/context.Context.html @@ -1,8 +1,8 @@ Context | probot

Class Context<E>

The context of the event that was triggered, including the payload and helpers for extracting information can be passed to GitHub API calls.

-
module.exports = app => {
  app.on('push', context => {
    context.log.info('Code was pushed to the repo, what should we do with it?');
  });
};
+
export default app => {
  app.on('push', context => {
    context.log.info('Code was pushed to the repo, what should we do with it?');
  });
};
 

-

Type Parameters

  • E extends WebhookEvents = WebhookEvents

Constructors

constructor +

Type Parameters

  • E extends WebhookEvents = WebhookEvents

Constructors

constructor

Properties

id log name @@ -13,20 +13,20 @@ issue pullRequest repo -

Constructors

constructor

  • new Context<E>(event, octokit, log): Context<E>

  • Type Parameters

    • E extends "status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested" = "status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested"

    Parameters

    • event: EmitterWebhookEvent<E>
    • octokit: Octokit & {} & {} & RestEndpointMethods & Api & API
    • log: Logger

    Returns Context<E>

Properties

id

id: string

log

log: Logger

A pino instance

-

name

name: "status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested"

octokit

octokit: Octokit & {} & {} & RestEndpointMethods & Api & API

An Octokit instance

-

Type declaration

    Type declaration

      payload

      payload: EmitterWebhookEvent<E>["payload"]

      The webhook event payload

      -

      Accessors

      isBot

      • get isBot(): boolean

      • Returns a boolean if the actor on the event was a bot.

        -

        Returns boolean

      Methods

      config

      • config<T>(fileName, defaultConfig?, deepMergeOptions?): Promise<null | T>

      • Reads the app configuration from the given YAML file in the .github +

      Constructors

      constructor

      • new Context<E>(event, octokit, log): Context<E>

      • Type Parameters

        • E extends "status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested" = "status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested"

        Parameters

        • event: EmitterWebhookEvent<E>
        • octokit: Octokit & {} & {} & RestEndpointMethods & Api & API
        • log: Logger

        Returns Context<E>

      Properties

      id

      id: string

      log

      log: Logger

      A pino instance

      +

      name

      name: "status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested"

      octokit

      octokit: Octokit & {} & {} & RestEndpointMethods & Api & API

      An Octokit instance

      +

      Type declaration

        Type declaration

          payload

          payload: EmitterWebhookEvent<E>["payload"]

          The webhook event payload

          +

          Accessors

          isBot

          • get isBot(): boolean

          • Returns a boolean if the actor on the event was a bot.

            +

            Returns boolean

          Methods

          config

          • config<T>(fileName, defaultConfig?, deepMergeOptions?): Promise<null | T>

          • Reads the app configuration from the given YAML file in the .github directory of the repository.

            For example, given a file named .github/config.yml:

            -
            close: true
            comment: Check the specs on the rotary girder.
+
            close: true
            comment: Check the specs on the rotary girder.
 
            
 
            Your app can read that file from the target repository:
            
-
            // Load config from .github/config.yml in the repository
            const config = await context.config('config.yml')

            if (config.close) {
              context.octokit.issues.comment(context.issue({body: config.comment}))
              context.octokit.issues.edit(context.issue({state: 'closed'}))
            }
+
            // Load config from .github/config.yml in the repository
            const config = await context.config('config.yml')

            if (config.close) {
              context.octokit.issues.comment(context.issue({body: config.comment}))
              context.octokit.issues.edit(context.issue({state: 'closed'}))
            }
 
            
 
            You can also use a defaultConfig object:
            
-
            // Load config from .github/config.yml in the repository and combine with default config
            const config = await context.config('config.yml', {comment: 'Make sure to check all the specs.'})

            if (config.close) {
              context.octokit.issues.comment(context.issue({body: config.comment}));
              context.octokit.issues.edit(context.issue({state: 'closed'}))
            }
+
            // Load config from .github/config.yml in the repository and combine with default config
            const config = await context.config('config.yml', {comment: 'Make sure to check all the specs.'})

            if (config.close) {
              context.octokit.issues.comment(context.issue({body: config.comment}));
              context.octokit.issues.edit(context.issue({state: 'closed'}))
            }
 
            
 
            Config files can also specify a base that they extend. deepMergeOptions can be used
 to configure how the target config, extended base, and default configs are merged.
            
@@ -38,22 +38,22 @@
          • Optional defaultConfig: T

            An object of default config options

          • Optional deepMergeOptions: Options

            Controls merging configs (from the deepmerge module)

          Returns Promise<null | T>

          Configuration object read from the file

          -

          issue

          • issue<T>(object?): RepoResultType<E> & {
                issue_number: RepoIssueNumberType<E>;
            } & T

          • Return the owner, repo, and issue_number params for making API requests +

          issue

          • issue<T>(object?): RepoResultType<E> & {
                issue_number: RepoIssueNumberType<E>;
            } & T

          • Return the owner, repo, and issue_number params for making API requests against an issue. The object passed in will be merged with the repo params.

            -
            const params = context.issue({body: 'Hello World!'})
            // Returns: {owner: 'username', repo: 'reponame', issue_number: 123, body: 'Hello World!'}
+
            const params = context.issue({body: 'Hello World!'})
            // Returns: {owner: 'username', repo: 'reponame', issue_number: 123, body: 'Hello World!'}

            Type Parameters

            • T

            Parameters

            • Optional object: T

              Params to be merged with the issue params.

              -

            Returns RepoResultType<E> & {
                issue_number: RepoIssueNumberType<E>;
            } & T

          pullRequest

          • pullRequest<T>(object?): RepoResultType<E> & {
                pull_number: RepoIssueNumberType<E>;
            } & T

          • Return the owner, repo, and pull_number params for making API requests +

          Returns RepoResultType<E> & {
              issue_number: RepoIssueNumberType<E>;
          } & T

          pullRequest

          • pullRequest<T>(object?): RepoResultType<E> & {
                pull_number: RepoIssueNumberType<E>;
            } & T

          • Return the owner, repo, and pull_number params for making API requests against a pull request. The object passed in will be merged with the repo params.

            -
            const params = context.pullRequest({body: 'Hello World!'})
            // Returns: {owner: 'username', repo: 'reponame', pull_number: 123, body: 'Hello World!'}
+
            const params = context.pullRequest({body: 'Hello World!'})
            // Returns: {owner: 'username', repo: 'reponame', pull_number: 123, body: 'Hello World!'}

            Type Parameters

            • T

            Parameters

            • Optional object: T

              Params to be merged with the pull request params.

              -

            Returns RepoResultType<E> & {
                pull_number: RepoIssueNumberType<E>;
            } & T

          repo

          • repo<T>(object?): RepoResultType<E> & T

          • Return the owner and repo params for making API requests against a +

          Returns RepoResultType<E> & {
              pull_number: RepoIssueNumberType<E>;
          } & T

          repo

          • repo<T>(object?): RepoResultType<E> & T

          • Return the owner and repo params for making API requests against a repository.

            -
            const params = context.repo({path: '.github/config.yml'})
            // Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}
+
            const params = context.repo({path: '.github/config.yml'})
            // Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}

            Type Parameters

            • T

            Parameters

            • Optional object: T

              Params to be merged with the repo params.

              -

            Returns RepoResultType<E> & T

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/classes/manifest_creation.ManifestCreation.html b/api/13.0.2/classes/manifest_creation.ManifestCreation.html index a810f897f83..d5431c842ec 100644 --- a/api/13.0.2/classes/manifest_creation.ManifestCreation.html +++ b/api/13.0.2/classes/manifest_creation.ManifestCreation.html @@ -1,11 +1,11 @@ -ManifestCreation | probot

          Class ManifestCreation

          Constructors

          constructor +ManifestCreation | probot

          Class ManifestCreation

          Constructors

          constructor

          Accessors

          createAppUrl pkg

          Methods

          createAppFromCode createWebhookChannel getManifest updateEnv -

          Constructors

          constructor

          Accessors

          createAppUrl

          pkg

          Methods

          createAppFromCode

          • createAppFromCode(code, probotOptions?): Promise<any>

          • Parameters

            • code: string
            • Optional probotOptions: OctokitOptions

            Returns Promise<any>

          createWebhookChannel

          getManifest

          updateEnv

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/classes/probot.Probot.html b/api/13.0.2/classes/probot.Probot.html index 09171b5fa8e..a025d4bcf3f 100644 --- a/api/13.0.2/classes/probot.Probot.html +++ b/api/13.0.2/classes/probot.Probot.html @@ -1,4 +1,4 @@ -Probot | probot

          Class Probot

          Constructors

          constructor +Probot | probot

          Class Probot

          Constructors

          constructor

          Properties

          auth log on @@ -11,7 +11,7 @@

          Methods

          load receive defaults -

          Constructors

          constructor

          Properties

          auth

          auth: ((installationId?, log?) => Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>)

          Type declaration

            • (installationId?, log?): Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

            • Parameters

              • Optional installationId: number
              • Optional log: Logger

              Returns Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

          log

          log: Logger

          on

          on: (<E>(event, callback) => void)

          Type declaration

            • <E>(event, callback): void

            • Type Parameters

              • E extends "status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested"

              Parameters

              • event: E | E[]
              • callback: HandlerFunction<E, SimplifiedObject>

              Returns void

          onAny

          onAny: ((callback) => void)

          Type declaration

            • (callback): void

            • Parameters

              • callback: ((event) => any)
                  • (event): any

                  • Parameters

                    • event: EmitterWebhookEvent

                    Returns any

              Returns void

          onError

          onError: ((callback) => void)

          Type declaration

            • (callback): void

            • Parameters

              • callback: ((event) => any)
                  • (event): any

                  • Parameters

                    • event: WebhookEventHandlerError<SimplifiedObject>

                    Returns any

              Returns void

          version

          version: String

          webhookPath

          webhookPath: string

          webhooks

          webhooks: ProbotWebhooks

          Static version

          version: string = VERSION

          Methods

          load

          receive

          • receive(event): Promise<void>

          • Parameters

            • event: EmitterWebhookEvent

            Returns Promise<void>

          Static defaults

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/classes/server_server.Server.html b/api/13.0.2/classes/server_server.Server.html index 548292b85e4..a210f338cd8 100644 --- a/api/13.0.2/classes/server_server.Server.html +++ b/api/13.0.2/classes/server_server.Server.html @@ -1,4 +1,4 @@ -Server | probot

          Class Server

          Constructors

          constructor +Server | probot

          Class Server

          Constructors

          constructor

          Properties

          expressApp log probotApp @@ -8,7 +8,7 @@ router start stop -

          Constructors

          constructor

          Properties

          expressApp

          expressApp: Application

          log

          log: Logger

          probotApp

          probotApp: Probot

          version

          version: string = VERSION

          Static version

          version: string = VERSION

          Methods

          load

          router

          start

          • start(): Promise<Server<typeof IncomingMessage, typeof ServerResponse>>

          • Returns Promise<Server<typeof IncomingMessage, typeof ServerResponse>>

          stop

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/apps_default.defaultApp.html b/api/13.0.2/functions/apps_default.defaultApp.html index 374ceca4bb1..ec5dcebbe6d 100644 --- a/api/13.0.2/functions/apps_default.defaultApp.html +++ b/api/13.0.2/functions/apps_default.defaultApp.html @@ -1,4 +1,4 @@ -defaultApp | probot

          Function defaultApp

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function defaultApp

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/apps_setup.setupAppFactory.html b/api/13.0.2/functions/apps_setup.setupAppFactory.html index 04ca9740779..b8021514988 100644 --- a/api/13.0.2/functions/apps_setup.setupAppFactory.html +++ b/api/13.0.2/functions/apps_setup.setupAppFactory.html @@ -1,4 +1,4 @@ -setupAppFactory | probot

          Function setupAppFactory

          • setupAppFactory(host, port): ((app, __namedParameters) => Promise<void>)

          • Parameters

            • host: undefined | string
            • port: undefined | number

            Returns ((app, __namedParameters) => Promise<void>)

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function setupAppFactory

          • setupAppFactory(host, port): ((app, __namedParameters) => Promise<void>)

          • Parameters

            • host: undefined | string
            • port: undefined | number

            Returns ((app, __namedParameters) => Promise<void>)

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/auth.auth.html b/api/13.0.2/functions/auth.auth.html index 131b944a166..89cda7e1141 100644 --- a/api/13.0.2/functions/auth.auth.html +++ b/api/13.0.2/functions/auth.auth.html @@ -3,11 +3,11 @@

          Note: app.auth is asynchronous, so it needs to be prefixed with a await to wait for the magic to happen.

          -
           module.exports = (app) => {
             app.on('issues.opened', async context => {
               const octokit = await app.auth();
             });
           };
+
           export default (app) => {
             app.on('issues.opened', async context => {
               const octokit = await app.auth();
             });
           };

          Parameters

          • state: State

            Probot application instance state, which is used to persist

          • Optional installationId: number

          Returns Promise<InstanceType<typeof ProbotOctokit>>

          An authenticated GitHub API client

          -

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/bin_read_cli_options.readCliOptions.html b/api/13.0.2/functions/bin_read_cli_options.readCliOptions.html index cc20e5a4e7a..48199d04e65 100644 --- a/api/13.0.2/functions/bin_read_cli_options.readCliOptions.html +++ b/api/13.0.2/functions/bin_read_cli_options.readCliOptions.html @@ -1,4 +1,4 @@ -readCliOptions | probot

          Function readCliOptions

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function readCliOptions

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/bin_read_env_options.readEnvOptions.html b/api/13.0.2/functions/bin_read_env_options.readEnvOptions.html index 5d6a7baae23..85a0335d78d 100644 --- a/api/13.0.2/functions/bin_read_env_options.readEnvOptions.html +++ b/api/13.0.2/functions/bin_read_env_options.readEnvOptions.html @@ -1,4 +1,4 @@ -readEnvOptions | probot

          Function readEnvOptions

          • readEnvOptions(env?): {
                appId: number;
                args: never[];
                baseUrl: string;
                host: undefined | string;
                logFormat: "json" | "pretty";
                logLevel: LogLevel;
                logLevelInString: boolean;
                logMessageKey: undefined | string;
                port: number;
                privateKey: undefined | string;
                redisConfig: undefined | string;
                secret: undefined | string;
                sentryDsn: undefined | string;
                webhookPath: undefined | string;
                webhookProxy: undefined | string;
            }

          • Parameters

            • env: ProcessEnv = process.env

            Returns {
                appId: number;
                args: never[];
                baseUrl: string;
                host: undefined | string;
                logFormat: "json" | "pretty";
                logLevel: LogLevel;
                logLevelInString: boolean;
                logMessageKey: undefined | string;
                port: number;
                privateKey: undefined | string;
                redisConfig: undefined | string;
                secret: undefined | string;
                sentryDsn: undefined | string;
                webhookPath: undefined | string;
                webhookProxy: undefined | string;
            }

            • appId: number
            • args: never[]
            • baseUrl: string
            • host: undefined | string
            • logFormat: "json" | "pretty"
            • logLevel: LogLevel
            • logLevelInString: boolean
            • logMessageKey: undefined | string
            • port: number
            • privateKey: undefined | string
            • redisConfig: undefined | string
            • secret: undefined | string
            • sentryDsn: undefined | string
            • webhookPath: undefined | string
            • webhookProxy: undefined | string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function readEnvOptions

          • readEnvOptions(env?): {
                appId: number;
                args: never[];
                baseUrl: string;
                host: undefined | string;
                logFormat: "json" | "pretty";
                logLevel: LogLevel;
                logLevelInString: boolean;
                logMessageKey: undefined | string;
                port: number;
                privateKey: undefined | string;
                redisConfig: undefined | string;
                secret: undefined | string;
                sentryDsn: undefined | string;
                webhookPath: undefined | string;
                webhookProxy: undefined | string;
            }

          • Parameters

            • env: ProcessEnv = process.env

            Returns {
                appId: number;
                args: never[];
                baseUrl: string;
                host: undefined | string;
                logFormat: "json" | "pretty";
                logLevel: LogLevel;
                logLevelInString: boolean;
                logMessageKey: undefined | string;
                port: number;
                privateKey: undefined | string;
                redisConfig: undefined | string;
                secret: undefined | string;
                sentryDsn: undefined | string;
                webhookPath: undefined | string;
                webhookProxy: undefined | string;
            }

            • appId: number
            • args: never[]
            • baseUrl: string
            • host: undefined | string
            • logFormat: "json" | "pretty"
            • logLevel: LogLevel
            • logLevelInString: boolean
            • logMessageKey: undefined | string
            • port: number
            • privateKey: undefined | string
            • redisConfig: undefined | string
            • secret: undefined | string
            • sentryDsn: undefined | string
            • webhookPath: undefined | string
            • webhookProxy: undefined | string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/create_node_middleware.createNodeMiddleware.html b/api/13.0.2/functions/create_node_middleware.createNodeMiddleware.html index 8f737c27102..c58ea3aa89c 100644 --- a/api/13.0.2/functions/create_node_middleware.createNodeMiddleware.html +++ b/api/13.0.2/functions/create_node_middleware.createNodeMiddleware.html @@ -1,4 +1,4 @@ -createNodeMiddleware | probot

          Function createNodeMiddleware

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function createNodeMiddleware

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/create_probot.createProbot.html b/api/13.0.2/functions/create_probot.createProbot.html index 82dd1f5c448..fb584edb64e 100644 --- a/api/13.0.2/functions/create_probot.createProbot.html +++ b/api/13.0.2/functions/create_probot.createProbot.html @@ -1,7 +1,7 @@ createProbot | probot

          Function createProbot

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/get_router.getRouter.html b/api/13.0.2/functions/get_router.getRouter.html index 66843e01a16..b0332dfb19c 100644 --- a/api/13.0.2/functions/get_router.getRouter.html +++ b/api/13.0.2/functions/get_router.getRouter.html @@ -2,7 +2,7 @@ expose HTTP endpoints

          Parameters

          • router: Router
          • Optional path: string

            the prefix for the routes

          Returns Router

          an express.Router

          -

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/helpers_get_error_handler.getErrorHandler.html b/api/13.0.2/functions/helpers_get_error_handler.getErrorHandler.html index 6e3be18abc0..9e78381ba4a 100644 --- a/api/13.0.2/functions/helpers_get_error_handler.getErrorHandler.html +++ b/api/13.0.2/functions/helpers_get_error_handler.getErrorHandler.html @@ -1,4 +1,4 @@ -getErrorHandler | probot

          Function getErrorHandler

          • getErrorHandler(log): ((error) => void)

          • Parameters

            • log: Logger

            Returns ((error) => void)

              • (error): void

              • Parameters

                • error: Error & {
                      event?: EmitterWebhookEvent;
                  }

                Returns void

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function getErrorHandler

          • getErrorHandler(log): ((error) => void)

          • Parameters

            • log: Logger

            Returns ((error) => void)

              • (error): void

              • Parameters

                • error: Error & {
                      event?: EmitterWebhookEvent;
                  }

                Returns void

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/helpers_get_log.getLog.html b/api/13.0.2/functions/helpers_get_log.getLog.html index 44d87e914c9..bee68df6510 100644 --- a/api/13.0.2/functions/helpers_get_log.getLog.html +++ b/api/13.0.2/functions/helpers_get_log.getLog.html @@ -1,4 +1,4 @@ -getLog | probot

          Function getLog

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function getLog

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/helpers_is_production.isProduction.html b/api/13.0.2/functions/helpers_is_production.isProduction.html index 3ca33e2da32..2862c45f665 100644 --- a/api/13.0.2/functions/helpers_is_production.isProduction.html +++ b/api/13.0.2/functions/helpers_is_production.isProduction.html @@ -1,4 +1,4 @@ -isProduction | probot

          Function isProduction

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function isProduction

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html b/api/13.0.2/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html index 3498c13f605..982dc13feee 100644 --- a/api/13.0.2/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html +++ b/api/13.0.2/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html @@ -1,4 +1,4 @@ -isSupportedNodeVersion | probot

          Function isSupportedNodeVersion

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function isSupportedNodeVersion

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/helpers_load_package_json.loadPackageJson.html b/api/13.0.2/functions/helpers_load_package_json.loadPackageJson.html index fc3cdcc386f..4515ad49f83 100644 --- a/api/13.0.2/functions/helpers_load_package_json.loadPackageJson.html +++ b/api/13.0.2/functions/helpers_load_package_json.loadPackageJson.html @@ -1,4 +1,4 @@ -loadPackageJson | probot

          Function loadPackageJson

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function loadPackageJson

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/helpers_rebind_log.rebindLog.html b/api/13.0.2/functions/helpers_rebind_log.rebindLog.html index d32f7ec2799..41eb7413e48 100644 --- a/api/13.0.2/functions/helpers_rebind_log.rebindLog.html +++ b/api/13.0.2/functions/helpers_rebind_log.rebindLog.html @@ -1,4 +1,4 @@ -rebindLog | probot

          Function rebindLog

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function rebindLog

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/helpers_resolve_app_function.resolveAppFunction.html b/api/13.0.2/functions/helpers_resolve_app_function.resolveAppFunction.html index 22ccd279f60..32721ae6b73 100644 --- a/api/13.0.2/functions/helpers_resolve_app_function.resolveAppFunction.html +++ b/api/13.0.2/functions/helpers_resolve_app_function.resolveAppFunction.html @@ -1,4 +1,4 @@ -resolveAppFunction | probot

          Function resolveAppFunction

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function resolveAppFunction

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/helpers_webhook_proxy.createWebhookProxy.html b/api/13.0.2/functions/helpers_webhook_proxy.createWebhookProxy.html index f6868a1ab9d..1851206ddad 100644 --- a/api/13.0.2/functions/helpers_webhook_proxy.createWebhookProxy.html +++ b/api/13.0.2/functions/helpers_webhook_proxy.createWebhookProxy.html @@ -1,4 +1,4 @@ -createWebhookProxy | probot

          Function createWebhookProxy

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function createWebhookProxy

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html b/api/13.0.2/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html index 8321dca9663..ce2890871f0 100644 --- a/api/13.0.2/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html +++ b/api/13.0.2/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html @@ -1,4 +1,4 @@ -getAuthenticatedOctokit | probot

          Function getAuthenticatedOctokit

          • getAuthenticatedOctokit(state, installationId?): Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

          • Parameters

            • state: State
            • Optional installationId: number

            Returns Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function getAuthenticatedOctokit

          • getAuthenticatedOctokit(state, installationId?): Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

          • Parameters

            • state: State
            • Optional installationId: number

            Returns Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html b/api/13.0.2/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html index b372735c622..ff2afa3060e 100644 --- a/api/13.0.2/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html +++ b/api/13.0.2/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html @@ -1,4 +1,4 @@ -getOctokitThrottleOptions | probot

          Function getOctokitThrottleOptions

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function getOctokitThrottleOptions

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html b/api/13.0.2/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html index f1e30e3db41..c11f86153cb 100644 --- a/api/13.0.2/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html +++ b/api/13.0.2/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html @@ -5,7 +5,7 @@ deeply when instantiated.

          Besides the authentication, the Octokit's baseUrl is set as well when run against a GitHub Enterprise Server with a custom domain.

          -

          Parameters

          • options: Options

          Returns typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/octokit_get_webhooks.getWebhooks.html b/api/13.0.2/functions/octokit_get_webhooks.getWebhooks.html index c241155c18e..af8a9bf92af 100644 --- a/api/13.0.2/functions/octokit_get_webhooks.getWebhooks.html +++ b/api/13.0.2/functions/octokit_get_webhooks.getWebhooks.html @@ -1,4 +1,4 @@ -getWebhooks | probot

          Function getWebhooks

          • getWebhooks(state): Webhooks<Context<"status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">>

          • Parameters

            Returns Webhooks<Context<"status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function getWebhooks

          • getWebhooks(state): Webhooks<Context<"status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">>

          • Parameters

            Returns Webhooks<Context<"status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html b/api/13.0.2/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html index 436ede83774..91a8c2df74d 100644 --- a/api/13.0.2/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html +++ b/api/13.0.2/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html @@ -1,4 +1,4 @@ -probotRequestLogging | probot

          Function probotRequestLogging

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function probotRequestLogging

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/octokit_octokit_webhooks_transform.webhookTransform.html b/api/13.0.2/functions/octokit_octokit_webhooks_transform.webhookTransform.html index 55372ebd659..5fc1055ac49 100644 --- a/api/13.0.2/functions/octokit_octokit_webhooks_transform.webhookTransform.html +++ b/api/13.0.2/functions/octokit_octokit_webhooks_transform.webhookTransform.html @@ -1,7 +1,7 @@ webhookTransform | probot

          Function webhookTransform

          • webhookTransform(state, event): Promise<Context<"status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">>

          • Probot's transform option, which extends the event object that is passed to webhook event handlers by @octokit/webhooks

            Parameters

            • state: State
            • event: EmitterWebhookEvent

            Returns Promise<Context<"status" | "branch_protection_rule" | "branch_protection_rule.created" | "branch_protection_rule.deleted" | "branch_protection_rule.edited" | "check_run" | "check_run.completed" | "check_run.created" | "check_run.requested_action" | "check_run.rerequested" | "check_suite" | "check_suite.completed" | "check_suite.requested" | "check_suite.rerequested" | "code_scanning_alert" | "code_scanning_alert.appeared_in_branch" | "code_scanning_alert.closed_by_user" | "code_scanning_alert.created" | "code_scanning_alert.fixed" | "code_scanning_alert.reopened" | "code_scanning_alert.reopened_by_user" | "commit_comment" | "commit_comment.created" | "create" | "delete" | "dependabot_alert" | "dependabot_alert.created" | "dependabot_alert.dismissed" | "dependabot_alert.fixed" | "dependabot_alert.reintroduced" | "dependabot_alert.reopened" | "deploy_key" | "deploy_key.created" | "deploy_key.deleted" | "deployment" | "deployment.created" | "deployment_protection_rule" | "deployment_protection_rule.requested" | "deployment_review" | "deployment_review.approved" | "deployment_review.rejected" | "deployment_review.requested" | "deployment_status" | "deployment_status.created" | "discussion" | "discussion.answered" | "discussion.category_changed" | "discussion.created" | "discussion.deleted" | "discussion.edited" | "discussion.labeled" | "discussion.locked" | "discussion.pinned" | "discussion.transferred" | "discussion.unanswered" | "discussion.unlabeled" | "discussion.unlocked" | "discussion.unpinned" | "discussion_comment" | "discussion_comment.created" | "discussion_comment.deleted" | "discussion_comment.edited" | "fork" | "github_app_authorization" | "github_app_authorization.revoked" | "gollum" | "installation" | "installation.created" | "installation.deleted" | "installation.new_permissions_accepted" | "installation.suspend" | "installation.unsuspend" | "installation_repositories" | "installation_repositories.added" | "installation_repositories.removed" | "installation_target" | "installation_target.renamed" | "issue_comment" | "issue_comment.created" | "issue_comment.deleted" | "issue_comment.edited" | "issues" | "issues.assigned" | "issues.closed" | "issues.deleted" | "issues.demilestoned" | "issues.edited" | "issues.labeled" | "issues.locked" | "issues.milestoned" | "issues.opened" | "issues.pinned" | "issues.reopened" | "issues.transferred" | "issues.unassigned" | "issues.unlabeled" | "issues.unlocked" | "issues.unpinned" | "label" | "label.created" | "label.deleted" | "label.edited" | "marketplace_purchase" | "marketplace_purchase.cancelled" | "marketplace_purchase.changed" | "marketplace_purchase.pending_change" | "marketplace_purchase.pending_change_cancelled" | "marketplace_purchase.purchased" | "member" | "member.added" | "member.edited" | "member.removed" | "membership" | "membership.added" | "membership.removed" | "merge_group" | "merge_group.checks_requested" | "meta" | "meta.deleted" | "milestone" | "milestone.closed" | "milestone.created" | "milestone.deleted" | "milestone.edited" | "milestone.opened" | "org_block" | "org_block.blocked" | "org_block.unblocked" | "organization" | "organization.deleted" | "organization.member_added" | "organization.member_invited" | "organization.member_removed" | "organization.renamed" | "package" | "package.published" | "package.updated" | "page_build" | "ping" | "project" | "project.closed" | "project.created" | "project.deleted" | "project.edited" | "project.reopened" | "project_card" | "project_card.converted" | "project_card.created" | "project_card.deleted" | "project_card.edited" | "project_card.moved" | "project_column" | "project_column.created" | "project_column.deleted" | "project_column.edited" | "project_column.moved" | "projects_v2_item" | "projects_v2_item.archived" | "projects_v2_item.converted" | "projects_v2_item.created" | "projects_v2_item.deleted" | "projects_v2_item.edited" | "projects_v2_item.reordered" | "projects_v2_item.restored" | "public" | "pull_request" | "pull_request.assigned" | "pull_request.auto_merge_disabled" | "pull_request.auto_merge_enabled" | "pull_request.closed" | "pull_request.converted_to_draft" | "pull_request.demilestoned" | "pull_request.dequeued" | "pull_request.edited" | "pull_request.enqueued" | "pull_request.labeled" | "pull_request.locked" | "pull_request.milestoned" | "pull_request.opened" | "pull_request.ready_for_review" | "pull_request.reopened" | "pull_request.review_request_removed" | "pull_request.review_requested" | "pull_request.synchronize" | "pull_request.unassigned" | "pull_request.unlabeled" | "pull_request.unlocked" | "pull_request_review" | "pull_request_review.dismissed" | "pull_request_review.edited" | "pull_request_review.submitted" | "pull_request_review_comment" | "pull_request_review_comment.created" | "pull_request_review_comment.deleted" | "pull_request_review_comment.edited" | "pull_request_review_thread" | "pull_request_review_thread.resolved" | "pull_request_review_thread.unresolved" | "push" | "registry_package" | "registry_package.published" | "registry_package.updated" | "release" | "release.created" | "release.deleted" | "release.edited" | "release.prereleased" | "release.published" | "release.released" | "release.unpublished" | "repository" | "repository.archived" | "repository.created" | "repository.deleted" | "repository.edited" | "repository.privatized" | "repository.publicized" | "repository.renamed" | "repository.transferred" | "repository.unarchived" | "repository_dispatch" | "repository_import" | "repository_vulnerability_alert" | "repository_vulnerability_alert.create" | "repository_vulnerability_alert.dismiss" | "repository_vulnerability_alert.reopen" | "repository_vulnerability_alert.resolve" | "secret_scanning_alert" | "secret_scanning_alert.created" | "secret_scanning_alert.reopened" | "secret_scanning_alert.resolved" | "secret_scanning_alert.revoked" | "secret_scanning_alert_location" | "secret_scanning_alert_location.created" | "security_advisory" | "security_advisory.performed" | "security_advisory.published" | "security_advisory.updated" | "security_advisory.withdrawn" | "sponsorship" | "sponsorship.cancelled" | "sponsorship.created" | "sponsorship.edited" | "sponsorship.pending_cancellation" | "sponsorship.pending_tier_change" | "sponsorship.tier_changed" | "star" | "star.created" | "star.deleted" | "team" | "team.added_to_repository" | "team.created" | "team.deleted" | "team.edited" | "team.removed_from_repository" | "team_add" | "watch" | "watch.started" | "workflow_dispatch" | "workflow_job" | "workflow_job.completed" | "workflow_job.in_progress" | "workflow_job.queued" | "workflow_job.waiting" | "workflow_run" | "workflow_run.completed" | "workflow_run.in_progress" | "workflow_run.requested">>

            See

            https://github.com/octokit/webhooks.js/#constructor

            -

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/run.run.html b/api/13.0.2/functions/run.run.html index ddd365aa3b3..0cf4e4cbdd6 100644 --- a/api/13.0.2/functions/run.run.html +++ b/api/13.0.2/functions/run.run.html @@ -1,5 +1,5 @@ run | probot

          Function run

          • run(appFnOrArgv, additionalOptions?): Promise<Server>

          • Parameters

            • appFnOrArgv: string[] | ApplicationFunction

              set to either a probot application function: (app) => { ... } or to process.argv

              -
            • Optional additionalOptions: AdditionalOptions

            Returns Promise<Server>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/server_logging_middleware.getLoggingMiddleware.html b/api/13.0.2/functions/server_logging_middleware.getLoggingMiddleware.html index c5adceac90f..87e549647de 100644 --- a/api/13.0.2/functions/server_logging_middleware.getLoggingMiddleware.html +++ b/api/13.0.2/functions/server_logging_middleware.getLoggingMiddleware.html @@ -1,4 +1,4 @@ -getLoggingMiddleware | probot

          Function getLoggingMiddleware

          • getLoggingMiddleware(logger, options?): HttpLogger

          • Parameters

            • logger: Logger
            • Optional options: Options<IncomingMessage, ServerResponse<IncomingMessage>, never>

            Returns HttpLogger

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function getLoggingMiddleware

          • getLoggingMiddleware(logger, options?): HttpLogger

          • Parameters

            • logger: Logger
            • Optional options: Options<IncomingMessage, ServerResponse<IncomingMessage>, never>

            Returns HttpLogger

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/views_import.importView.html b/api/13.0.2/functions/views_import.importView.html index fa8dd18b82c..88aa4f65380 100644 --- a/api/13.0.2/functions/views_import.importView.html +++ b/api/13.0.2/functions/views_import.importView.html @@ -1,4 +1,4 @@ -importView | probot

          Function importView

          • importView(__namedParameters): string

          • Parameters

            • __namedParameters: {
                  GH_HOST: string;
                  WEBHOOK_PROXY_URL?: string;
                  name?: string;
              }
              • GH_HOST: string
              • Optional WEBHOOK_PROXY_URL?: string
              • Optional name?: string

            Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function importView

          • importView(__namedParameters): string

          • Parameters

            • __namedParameters: {
                  GH_HOST: string;
                  WEBHOOK_PROXY_URL?: string;
                  name?: string;
              }
              • GH_HOST: string
              • Optional WEBHOOK_PROXY_URL?: string
              • Optional name?: string

            Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/views_probot.probotView.html b/api/13.0.2/functions/views_probot.probotView.html index 566577d451d..1edf31fb418 100644 --- a/api/13.0.2/functions/views_probot.probotView.html +++ b/api/13.0.2/functions/views_probot.probotView.html @@ -1,4 +1,4 @@ -probotView | probot

          Function probotView

          • probotView(__namedParameters): string

          • Parameters

            • __namedParameters: {
                  description?: string;
                  name?: string;
                  version?: string;
              }
              • Optional description?: string
              • Optional name?: string
              • Optional version?: string

            Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function probotView

          • probotView(__namedParameters): string

          • Parameters

            • __namedParameters: {
                  description?: string;
                  name?: string;
                  version?: string;
              }
              • Optional description?: string
              • Optional name?: string
              • Optional version?: string

            Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/views_setup.setupView.html b/api/13.0.2/functions/views_setup.setupView.html index 7663762e542..bb1b7d7652e 100644 --- a/api/13.0.2/functions/views_setup.setupView.html +++ b/api/13.0.2/functions/views_setup.setupView.html @@ -1,4 +1,4 @@ -setupView | probot

          Function setupView

          • setupView(__namedParameters): string

          • Parameters

            • __namedParameters: {
                  createAppUrl: string;
                  description?: string;
                  manifest: string;
                  name?: string;
                  version?: string;
              }
              • createAppUrl: string
              • Optional description?: string
              • manifest: string
              • Optional name?: string
              • Optional version?: string

            Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function setupView

          • setupView(__namedParameters): string

          • Parameters

            • __namedParameters: {
                  createAppUrl: string;
                  description?: string;
                  manifest: string;
                  name?: string;
                  version?: string;
              }
              • createAppUrl: string
              • Optional description?: string
              • manifest: string
              • Optional name?: string
              • Optional version?: string

            Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/functions/views_success.successView.html b/api/13.0.2/functions/views_success.successView.html index cd84a3950e7..a3316508427 100644 --- a/api/13.0.2/functions/views_success.successView.html +++ b/api/13.0.2/functions/views_success.successView.html @@ -1,4 +1,4 @@ -successView | probot

          Function successView

          • successView(__namedParameters): string

          • Parameters

            • __namedParameters: {
                  name?: string;
              }
              • Optional name?: string

            Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Function successView

          • successView(__namedParameters): string

          • Parameters

            • __namedParameters: {
                  name?: string;
              }
              • Optional name?: string

            Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/interfaces/helpers_resolve_app_function.ResolveOptions.html b/api/13.0.2/interfaces/helpers_resolve_app_function.ResolveOptions.html index 868bdf852bd..52a8ad8161c 100644 --- a/api/13.0.2/interfaces/helpers_resolve_app_function.ResolveOptions.html +++ b/api/13.0.2/interfaces/helpers_resolve_app_function.ResolveOptions.html @@ -1,6 +1,6 @@ -ResolveOptions | probot

          Interface ResolveOptions

          interface ResolveOptions {
              basedir?: string;
              resolver?: Resolver;
          }

          Properties

          basedir? +ResolveOptions | probot

          Interface ResolveOptions

          interface ResolveOptions {
              basedir?: string;
              resolver?: Resolver;
          }

          Properties

          basedir? resolver? -

          Properties

          Optional basedir

          basedir?: string

          Optional resolver

          resolver?: Resolver

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html b/api/13.0.2/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html index 865bf5f90eb..f8493212ae8 100644 --- a/api/13.0.2/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html +++ b/api/13.0.2/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html @@ -1,9 +1,9 @@ -WebhookProxyOptions | probot

          Interface WebhookProxyOptions

          interface WebhookProxyOptions {
              fetch?: Function;
              logger: Logger;
              path?: string;
              port?: number;
              url: string;
          }

          Properties

          fetch? +WebhookProxyOptions | probot

          Interface WebhookProxyOptions

          interface WebhookProxyOptions {
              fetch?: Function;
              logger: Logger;
              path?: string;
              port?: number;
              url: string;
          }

          Properties

          fetch? logger path? port? url -

          Properties

          Optional fetch

          fetch?: Function

          logger

          logger: Logger

          Optional path

          path?: string

          Optional port

          port?: number

          url

          url: string

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/interfaces/types.Options.html b/api/13.0.2/interfaces/types.Options.html index a5d11f90199..f1261333ce3 100644 --- a/api/13.0.2/interfaces/types.Options.html +++ b/api/13.0.2/interfaces/types.Options.html @@ -1,4 +1,4 @@ -Options | probot

          Interface Options

          interface Options {
              Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>;
              appId?: string | number;
              baseUrl?: string;
              githubToken?: string;
              host?: string;
              log?: Logger;
              logLevel?: "fatal" | "error" | "warn" | "info" | "debug" | "trace";
              logMessageKey?: string;
              port?: number;
              privateKey?: string;
              redisConfig?: string | RedisOptions;
              request?: RequestRequestOptions;
              secret?: string;
              webhookPath?: string;
          }

          Properties

          Octokit? +Options | probot

          Interface Options

          interface Options {
              Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>;
              appId?: string | number;
              baseUrl?: string;
              githubToken?: string;
              host?: string;
              log?: Logger;
              logLevel?: "fatal" | "error" | "warn" | "info" | "debug" | "trace";
              logMessageKey?: string;
              port?: number;
              privateKey?: string;
              redisConfig?: string | RedisOptions;
              request?: RequestRequestOptions;
              secret?: string;
              webhookPath?: string;
          }

          Properties

          Octokit? appId? baseUrl? githubToken? @@ -12,7 +12,7 @@ request? secret? webhookPath? -

          Properties

          Optional Octokit

          Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>

          Optional appId

          appId?: string | number

          Optional baseUrl

          baseUrl?: string

          Optional githubToken

          githubToken?: string

          Optional host

          host?: string

          Optional log

          log?: Logger

          Optional logLevel

          logLevel?: "fatal" | "error" | "warn" | "info" | "debug" | "trace"

          Optional logMessageKey

          logMessageKey?: string

          Optional port

          port?: number

          Optional privateKey

          privateKey?: string

          Optional redisConfig

          redisConfig?: string | RedisOptions

          Optional request

          request?: RequestRequestOptions

          Optional secret

          secret?: string

          Optional webhookPath

          webhookPath?: string

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/modules/apps_default.html b/api/13.0.2/modules/apps_default.html index 3cdb26d3137..5c27b2ed809 100644 --- a/api/13.0.2/modules/apps_default.html +++ b/api/13.0.2/modules/apps_default.html @@ -1,4 +1,4 @@ -apps/default | probot

          Module apps/default

          Index

          Functions

          defaultApp +apps/default | probot

          Module apps/default

          Index

          Functions

          defaultApp

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module apps/setup

          Index

          Functions

          setupAppFactory +apps/setup | probot

          Module apps/setup

          Index

          Functions

          setupAppFactory

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module auth

          Index

          Functions

          auth +auth | probot

          Module auth

          Index

          Functions

          auth

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module bin/probot

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module bin/probot

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/modules/bin_probot_receive.html b/api/13.0.2/modules/bin_probot_receive.html index 97b83083e87..c725270cdaa 100644 --- a/api/13.0.2/modules/bin_probot_receive.html +++ b/api/13.0.2/modules/bin_probot_receive.html @@ -1,4 +1,4 @@ -bin/probot-receive | probot

          Module bin/probot-receive

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module bin/probot-receive

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/modules/bin_probot_run.html b/api/13.0.2/modules/bin_probot_run.html index 012ecff0659..0447788cca5 100644 --- a/api/13.0.2/modules/bin_probot_run.html +++ b/api/13.0.2/modules/bin_probot_run.html @@ -1,4 +1,4 @@ -bin/probot-run | probot

          Module bin/probot-run

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module bin/probot-run

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/modules/bin_read_cli_options.html b/api/13.0.2/modules/bin_read_cli_options.html index 2177361f7e2..8c5f31e55d2 100644 --- a/api/13.0.2/modules/bin_read_cli_options.html +++ b/api/13.0.2/modules/bin_read_cli_options.html @@ -1,4 +1,4 @@ -bin/read-cli-options | probot

          Module bin/read-cli-options

          Index

          Functions

          readCliOptions +bin/read-cli-options | probot

          Module bin/read-cli-options

          Index

          Functions

          readCliOptions

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module bin/read-env-options

          Index

          Functions

          readEnvOptions +bin/read-env-options | probot

          Module bin/read-env-options

          Index

          Functions

          readEnvOptions

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module context

          Index

          Classes

          Context +context | probot

          Module context

          Index

          Classes

          Context

          Type Aliases

          MergeOptions

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module create-node-middleware

          Index

          Functions

          createNodeMiddleware +create-node-middleware | probot

          Module create-node-middleware

          Index

          Functions

          createNodeMiddleware

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module create-probot

          Index

          Functions

          createProbot +create-probot | probot

          Module create-probot

          Index

          Functions

          createProbot

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module get-router

          Index

          Functions

          getRouter +get-router | probot

          Module get-router

          Index

          Functions

          getRouter

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module helpers/get-error-handler

          Index

          Functions

          getErrorHandler +helpers/get-error-handler | probot

          Module helpers/get-error-handler

          Index

          Functions

          getErrorHandler

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module helpers/get-log

          Index

          Type Aliases

          GetLogOptions +helpers/get-log | probot

          Module helpers/get-log

          Index

          Type Aliases

          GetLogOptions

          Functions

          getLog

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module helpers/is-production

          Index

          Functions

          isProduction +helpers/is-production | probot

          Module helpers/is-production

          Index

          Functions

          isProduction

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module helpers/is-supported-node-version

          Index

          Functions

          isSupportedNodeVersion +helpers/is-supported-node-version | probot

          Module helpers/is-supported-node-version

          Index

          Functions

          isSupportedNodeVersion

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module helpers/load-package-json

          Index

          Functions

          loadPackageJson +helpers/load-package-json | probot

          Module helpers/load-package-json

          Index

          Functions

          loadPackageJson

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module helpers/rebind-log

          Index

          Functions

          rebindLog +helpers/rebind-log | probot

          Module helpers/rebind-log

          Index

          Functions

          rebindLog

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module helpers/resolve-app-function

          Index

          Interfaces

          ResolveOptions +helpers/resolve-app-function | probot

          Module helpers/resolve-app-function

          Index

          Interfaces

          ResolveOptions

          Type Aliases

          Resolver

          Functions

          resolveAppFunction

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module helpers/webhook-proxy

          Index

          Interfaces

          WebhookProxyOptions +helpers/webhook-proxy | probot

          Module helpers/webhook-proxy

          Index

          Interfaces

          WebhookProxyOptions

          Functions

          createWebhookProxy

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module index

          References

          ApplicationFunction +index | probot

          Module index

          References

          ApplicationFunction ApplicationFunctionOptions Context Options diff --git a/api/13.0.2/modules/manifest_creation.html b/api/13.0.2/modules/manifest_creation.html index f7ad05f9802..e0e9dd42584 100644 --- a/api/13.0.2/modules/manifest_creation.html +++ b/api/13.0.2/modules/manifest_creation.html @@ -1,4 +1,4 @@ -manifest-creation | probot

          Module manifest-creation

          Index

          Classes

          ManifestCreation +manifest-creation | probot

          Module manifest-creation

          Index

          Classes

          ManifestCreation

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module octokit/get-authenticated-octokit

          Index

          Functions

          getAuthenticatedOctokit +octokit/get-authenticated-octokit | probot

          Module octokit/get-authenticated-octokit

          Index

          Functions

          getAuthenticatedOctokit

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module octokit/get-octokit-throttle-options

          Index

          Functions

          getOctokitThrottleOptions +octokit/get-octokit-throttle-options | probot

          Module octokit/get-octokit-throttle-options

          Index

          Functions

          getOctokitThrottleOptions

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module octokit/get-probot-octokit-with-defaults

          Index

          Functions

          getProbotOctokitWithDefaults +octokit/get-probot-octokit-with-defaults | probot

          Module octokit/get-probot-octokit-with-defaults

          Index

          Functions

          getProbotOctokitWithDefaults

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module octokit/get-webhooks

          Index

          Functions

          getWebhooks +octokit/get-webhooks | probot

          Module octokit/get-webhooks

          Index

          Functions

          getWebhooks

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module octokit/octokit-plugin-probot-request-logging

          Index

          Functions

          probotRequestLogging +octokit/octokit-plugin-probot-request-logging | probot

          Module octokit/octokit-plugin-probot-request-logging

          Index

          Functions

          probotRequestLogging

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module octokit/octokit-webhooks-transform

          Index

          Functions

          webhookTransform +octokit/octokit-webhooks-transform | probot

          Module octokit/octokit-webhooks-transform

          Index

          Functions

          webhookTransform

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module octokit/probot-octokit

          Index

          Type Aliases

          ProbotOctokit +octokit/probot-octokit | probot

          Module octokit/probot-octokit

          Index

          Type Aliases

          ProbotOctokit

          Variables

          ProbotOctokit

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module probot

          Index

          Classes

          Probot +probot | probot

          Module probot

          Index

          Classes

          Probot

          Type Aliases

          Constructor

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module run

          Index

          Functions

          run +run | probot

          Module run

          Index

          Functions

          run

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module server/logging-middleware

          Index

          Functions

          getLoggingMiddleware +server/logging-middleware | probot

          Module server/logging-middleware

          Index

          Functions

          getLoggingMiddleware

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module server/server

          Index

          Classes

          Server +server/server | probot

          Module server/server

          Index

          Classes

          Server

          Variables

          defaultWebhooksPath

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module types

          Index

          Interfaces

          Options +types | probot

          Module types

          Index

          Interfaces

          Options

          Type Aliases

          ApplicationFunction ApplicationFunctionOptions Env diff --git a/api/13.0.2/modules/version.html b/api/13.0.2/modules/version.html index 1d5b0878a65..7deec05f76b 100644 --- a/api/13.0.2/modules/version.html +++ b/api/13.0.2/modules/version.html @@ -1,4 +1,4 @@ -version | probot

          Module version

          Index

          Variables

          VERSION +version | probot

          Module version

          Index

          Variables

          VERSION

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module views/import

          Index

          Functions

          importView +views/import | probot

          Module views/import

          Index

          Functions

          importView

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module views/probot

          Index

          Functions

          probotView +views/probot | probot

          Module views/probot

          Index

          Functions

          probotView

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module views/setup

          Index

          Functions

          setupView +views/setup | probot

          Module views/setup

          Index

          Functions

          setupView

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Module views/success

          Index

          Functions

          successView +views/success | probot

          Module views/success

          Index

          Functions

          successView

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias MergeOptions

          MergeOptions: merge.Options

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias MergeOptions

          MergeOptions: merge.Options

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/helpers_get_log.GetLogOptions.html b/api/13.0.2/types/helpers_get_log.GetLogOptions.html index c68ecc32171..74145adb181 100644 --- a/api/13.0.2/types/helpers_get_log.GetLogOptions.html +++ b/api/13.0.2/types/helpers_get_log.GetLogOptions.html @@ -1,4 +1,4 @@ -GetLogOptions | probot

          Type alias GetLogOptions

          GetLogOptions: {
              level?: LogLevel;
              logMessageKey?: string;
          } & Options

          Type declaration

          • Optional level?: LogLevel
          • Optional logMessageKey?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias GetLogOptions

          GetLogOptions: {
              level?: LogLevel;
              logMessageKey?: string;
          } & Options

          Type declaration

          • Optional level?: LogLevel
          • Optional logMessageKey?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/helpers_resolve_app_function.Resolver.html b/api/13.0.2/types/helpers_resolve_app_function.Resolver.html index e5ab2b0f572..beb2013b363 100644 --- a/api/13.0.2/types/helpers_resolve_app_function.Resolver.html +++ b/api/13.0.2/types/helpers_resolve_app_function.Resolver.html @@ -1,4 +1,4 @@ -Resolver | probot

          Type alias Resolver

          Resolver: ((appFnId, opts) => string)

          Type declaration

            • (appFnId, opts): string

            • Parameters

              • appFnId: string
              • opts: {
                    basedir: string;
                }
                • basedir: string

              Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias Resolver

          Resolver: ((appFnId, opts) => string)

          Type declaration

            • (appFnId, opts): string

            • Parameters

              • appFnId: string
              • opts: {
                    basedir: string;
                }
                • basedir: string

              Returns string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/octokit_probot_octokit.ProbotOctokit.html b/api/13.0.2/types/octokit_probot_octokit.ProbotOctokit.html index 5db806b10fc..f9f606ff4fe 100644 --- a/api/13.0.2/types/octokit_probot_octokit.ProbotOctokit.html +++ b/api/13.0.2/types/octokit_probot_octokit.ProbotOctokit.html @@ -1,4 +1,4 @@ -ProbotOctokit | probot

          Type alias ProbotOctokit

          ProbotOctokit: InstanceType<typeof ProbotOctokit>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias ProbotOctokit

          ProbotOctokit: InstanceType<typeof ProbotOctokit>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/probot.Constructor.html b/api/13.0.2/types/probot.Constructor.html index 41c9932a4c6..c9fe0ebc74d 100644 --- a/api/13.0.2/types/probot.Constructor.html +++ b/api/13.0.2/types/probot.Constructor.html @@ -1,4 +1,4 @@ -Constructor | probot

          Type alias Constructor<T>

          Constructor<T>: (new (...args) => T)

          Type Parameters

          • T = any

          Type declaration

            • new (...args): T

            • Parameters

              • Rest ...args: any[]

              Returns T

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias Constructor<T>

          Constructor<T>: (new (...args) => T)

          Type Parameters

          • T = any

          Type declaration

            • new (...args): T

            • Parameters

              • Rest ...args: any[]

              Returns T

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.ApplicationFunction.html b/api/13.0.2/types/types.ApplicationFunction.html index 693a058469c..4a6610fe404 100644 --- a/api/13.0.2/types/types.ApplicationFunction.html +++ b/api/13.0.2/types/types.ApplicationFunction.html @@ -1,4 +1,4 @@ -ApplicationFunction | probot

          Type alias ApplicationFunction

          ApplicationFunction: ((app, options) => void | Promise<void>)

          Type declaration

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias ApplicationFunction

          ApplicationFunction: ((app, options) => void | Promise<void>)

          Type declaration

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.ApplicationFunctionOptions.html b/api/13.0.2/types/types.ApplicationFunctionOptions.html index 33bb2e35333..4beb96f6af3 100644 --- a/api/13.0.2/types/types.ApplicationFunctionOptions.html +++ b/api/13.0.2/types/types.ApplicationFunctionOptions.html @@ -1,4 +1,4 @@ -ApplicationFunctionOptions | probot

          Type alias ApplicationFunctionOptions

          ApplicationFunctionOptions: {
              cwd?: string;
              getRouter?: ((path?) => express.Router);
              [key: string]: unknown;
          }

          Type declaration

          • [key: string]: unknown
          • Optional cwd?: string
          • Optional getRouter?: ((path?) => express.Router)
              • (path?): express.Router

              • Parameters

                • Optional path: string

                Returns express.Router

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias ApplicationFunctionOptions

          ApplicationFunctionOptions: {
              cwd?: string;
              getRouter?: ((path?) => express.Router);
              [key: string]: unknown;
          }

          Type declaration

          • [key: string]: unknown
          • Optional cwd?: string
          • Optional getRouter?: ((path?) => express.Router)
              • (path?): express.Router

              • Parameters

                • Optional path: string

                Returns express.Router

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.Env.html b/api/13.0.2/types/types.Env.html index 215f4b30e00..3572b2a9449 100644 --- a/api/13.0.2/types/types.Env.html +++ b/api/13.0.2/types/types.Env.html @@ -1,4 +1,4 @@ -Env | probot

          Type alias Env

          Env: Record<Uppercase<string>, string>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias Env

          Env: Record<Uppercase<string>, string>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.Manifest.html b/api/13.0.2/types/types.Manifest.html index 96d5edd3a7f..28bd8d02e0e 100644 --- a/api/13.0.2/types/types.Manifest.html +++ b/api/13.0.2/types/types.Manifest.html @@ -10,7 +10,7 @@
        • Optional setup_on_update?: boolean

          Set to true to redirect users to the setup_url after they update your GitHub App installation.

        • Optional setup_url?: string

          A full URL to redirect users to after they install your GitHub App if additional setup is required.

        • url: string

          Required. The homepage of your GitHub App.

          -

          • Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.MiddlewareOptions.html b/api/13.0.2/types/types.MiddlewareOptions.html index daad29aee61..5d036d02ec5 100644 --- a/api/13.0.2/types/types.MiddlewareOptions.html +++ b/api/13.0.2/types/types.MiddlewareOptions.html @@ -1,4 +1,4 @@ -MiddlewareOptions | probot

          Type alias MiddlewareOptions

          MiddlewareOptions: {
              probot: Probot;
              webhooksPath?: string;
              [key: string]: unknown;
          }

          Type declaration

          • [key: string]: unknown
          • probot: Probot
          • Optional webhooksPath?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias MiddlewareOptions

          MiddlewareOptions: {
              probot: Probot;
              webhooksPath?: string;
              [key: string]: unknown;
          }

          Type declaration

          • [key: string]: unknown
          • probot: Probot
          • Optional webhooksPath?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.OctokitOptions.html b/api/13.0.2/types/types.OctokitOptions.html index de8da205ef5..2bc987dcf94 100644 --- a/api/13.0.2/types/types.OctokitOptions.html +++ b/api/13.0.2/types/types.OctokitOptions.html @@ -1,4 +1,4 @@ -OctokitOptions | probot

          Type alias OctokitOptions

          OctokitOptions: NonNullable<ConstructorParameters<typeof ProbotOctokit>[0]>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias OctokitOptions

          OctokitOptions: NonNullable<ConstructorParameters<typeof ProbotOctokit>[0]>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.PackageJson.html b/api/13.0.2/types/types.PackageJson.html index ed9a7fdcc79..ce06d5c3dfa 100644 --- a/api/13.0.2/types/types.PackageJson.html +++ b/api/13.0.2/types/types.PackageJson.html @@ -1,4 +1,4 @@ -PackageJson | probot

          Type alias PackageJson

          PackageJson: {
              description?: string;
              engines?: {
                  [key: string]: string;
              };
              homepage?: string;
              name?: string;
              repository?: string;
              version?: string;
          }

          Type declaration

          • Optional description?: string
          • Optional engines?: {
                [key: string]: string;
            }
            • [key: string]: string
          • Optional homepage?: string
          • Optional name?: string
          • Optional repository?: string
          • Optional version?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias PackageJson

          PackageJson: {
              description?: string;
              engines?: {
                  [key: string]: string;
              };
              homepage?: string;
              name?: string;
              repository?: string;
              version?: string;
          }

          Type declaration

          • Optional description?: string
          • Optional engines?: {
                [key: string]: string;
            }
            • [key: string]: string
          • Optional homepage?: string
          • Optional name?: string
          • Optional repository?: string
          • Optional version?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.ProbotWebhooks.html b/api/13.0.2/types/types.ProbotWebhooks.html index 977a0e73374..12c8a069cb0 100644 --- a/api/13.0.2/types/types.ProbotWebhooks.html +++ b/api/13.0.2/types/types.ProbotWebhooks.html @@ -1,4 +1,4 @@ -ProbotWebhooks | probot

          Type alias ProbotWebhooks

          ProbotWebhooks: Webhooks<SimplifiedObject>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias ProbotWebhooks

          ProbotWebhooks: Webhooks<SimplifiedObject>

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.ServerOptions.html b/api/13.0.2/types/types.ServerOptions.html index 93c5646131a..4279b8f58a6 100644 --- a/api/13.0.2/types/types.ServerOptions.html +++ b/api/13.0.2/types/types.ServerOptions.html @@ -1,4 +1,4 @@ -ServerOptions | probot

          Type alias ServerOptions

          ServerOptions: {
              Probot: typeof Probot;
              cwd?: string;
              host?: string;
              log?: Logger;
              loggingOptions?: LoggingOptions;
              port?: number;
              request?: RequestRequestOptions;
              webhookPath?: string;
              webhookProxy?: string;
          }

          Type declaration

          • Probot: typeof Probot
          • Optional cwd?: string
          • Optional host?: string
          • Optional log?: Logger
          • Optional loggingOptions?: LoggingOptions
          • Optional port?: number
          • Optional request?: RequestRequestOptions
          • Optional webhookPath?: string
          • Optional webhookProxy?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias ServerOptions

          ServerOptions: {
              Probot: typeof Probot;
              cwd?: string;
              host?: string;
              log?: Logger;
              loggingOptions?: LoggingOptions;
              port?: number;
              request?: RequestRequestOptions;
              webhookPath?: string;
              webhookProxy?: string;
          }

          Type declaration

          • Probot: typeof Probot
          • Optional cwd?: string
          • Optional host?: string
          • Optional log?: Logger
          • Optional loggingOptions?: LoggingOptions
          • Optional port?: number
          • Optional request?: RequestRequestOptions
          • Optional webhookPath?: string
          • Optional webhookProxy?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/types/types.State.html b/api/13.0.2/types/types.State.html index a33b9b688a1..4b1c288faf0 100644 --- a/api/13.0.2/types/types.State.html +++ b/api/13.0.2/types/types.State.html @@ -1,4 +1,4 @@ -State | probot

          Type alias State

          State: {
              Octokit: typeof ProbotOctokit;
              appId?: number;
              baseUrl?: string;
              cache?: LRUCache<number, string>;
              githubToken?: string;
              host?: string;
              log: Logger;
              octokit: ProbotOctokit;
              port?: number;
              privateKey?: string;
              request?: RequestRequestOptions;
              webhookPath: string;
              webhooks: {
                  secret?: string;
              };
          }

          Type declaration

          • Octokit: typeof ProbotOctokit
          • Optional appId?: number
          • Optional baseUrl?: string
          • Optional cache?: LRUCache<number, string>
          • Optional githubToken?: string
          • Optional host?: string
          • log: Logger
          • octokit: ProbotOctokit
          • Optional port?: number
          • Optional privateKey?: string
          • Optional request?: RequestRequestOptions
          • webhookPath: string
          • webhooks: {
                secret?: string;
            }
            • Optional secret?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Type alias State

          State: {
              Octokit: typeof ProbotOctokit;
              appId?: number;
              baseUrl?: string;
              cache?: LRUCache<number, string>;
              githubToken?: string;
              host?: string;
              log: Logger;
              octokit: ProbotOctokit;
              port?: number;
              privateKey?: string;
              request?: RequestRequestOptions;
              webhookPath: string;
              webhooks: {
                  secret?: string;
              };
          }

          Type declaration

          • Octokit: typeof ProbotOctokit
          • Optional appId?: number
          • Optional baseUrl?: string
          • Optional cache?: LRUCache<number, string>
          • Optional githubToken?: string
          • Optional host?: string
          • log: Logger
          • octokit: ProbotOctokit
          • Optional port?: number
          • Optional privateKey?: string
          • Optional request?: RequestRequestOptions
          • webhookPath: string
          • webhooks: {
                secret?: string;
            }
            • Optional secret?: string

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/variables/octokit_probot_octokit.ProbotOctokit-1.html b/api/13.0.2/variables/octokit_probot_octokit.ProbotOctokit-1.html index 396ad0ba1c7..f58c2af1682 100644 --- a/api/13.0.2/variables/octokit_probot_octokit.ProbotOctokit-1.html +++ b/api/13.0.2/variables/octokit_probot_octokit.ProbotOctokit-1.html @@ -1,4 +1,4 @@ -ProbotOctokit | probot

          Variable ProbotOctokitConst

          ProbotOctokit: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API> = ...

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Variable ProbotOctokitConst

          ProbotOctokit: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API> = ...

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/variables/server_server.defaultWebhooksPath.html b/api/13.0.2/variables/server_server.defaultWebhooksPath.html index 6f0df43d46f..9af0d747b69 100644 --- a/api/13.0.2/variables/server_server.defaultWebhooksPath.html +++ b/api/13.0.2/variables/server_server.defaultWebhooksPath.html @@ -1,4 +1,4 @@ -defaultWebhooksPath | probot

          Variable defaultWebhooksPathConst

          defaultWebhooksPath: "/api/github/webhooks" = "/api/github/webhooks"

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Variable defaultWebhooksPathConst

          defaultWebhooksPath: "/api/github/webhooks" = "/api/github/webhooks"

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file diff --git a/api/13.0.2/variables/version.VERSION.html b/api/13.0.2/variables/version.VERSION.html index 224f9ebb00a..ac0dd55d114 100644 --- a/api/13.0.2/variables/version.VERSION.html +++ b/api/13.0.2/variables/version.VERSION.html @@ -1,4 +1,4 @@ -VERSION | probot

          Variable VERSIONConst

          VERSION: "0.0.0-development" = "0.0.0-development"

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          Variable VERSIONConst

          VERSION: "0.0.0-development" = "0.0.0-development"

          Settings

          Member Visibility

          Theme

          Generated using TypeDoc

          \ No newline at end of file