Azure Connectors Node.js SDK
    Preparing search index...

    Typed client for the github connector.

    Hierarchy (View Summary)

    Index
    • Add selected repository to an organization secret

      Parameters

      Returns Promise<void>

      Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    • Compare two commits

      Parameters

      • repositoryOwner: string
      • repositoryName: string
      • base: string
      • head: string
      • accept: string
      • options: ConnectorOperationOptions = {}

      Returns Promise<CommitComparison>

      Both base and head must be branch names in repositoryName. To compare branches across other repositories in the same network as repositoryName, use the format <USERNAME>:branch. The response is equivalent to running the git log base..head command; however, commits are returned in chronological order.

    • Create a repository dispatch event

      Parameters

      Returns Promise<void>

      This operation is to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs.

    • Get a reference

      Parameters

      Returns Promise<GitReference>

      Returns a single reference from your Git database. The reference parameter must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the reference doesn't match an existing ref, a 404 is returned.

    • Remove selected repository from an organization secret

      Parameters

      Returns Promise<void>

      Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

    • Update a pull request

      Parameters

      Returns Promise<PullRequest>

      This operation is used to update a pull request for the repository. To update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.