@backstage/integration
Helpers for managing integrations towards external systems
Classes
Class |
Description |
---|---|
Integrates with AWS CodeCommit. | |
Integrates with AWS S3 or compatible solutions. | |
Microsoft Azure based integration. | |
A Bitbucket Cloud based integration. | |
A Bitbucket based integration. | |
A Bitbucket Server based integration. | |
Default implementation of AzureDevOpsCredentialsProvider. | |
Handles the creation and caching of credentials for GitHub integrations. | |
Handles the creation and caching of credentials for GitLab integrations. | |
A Gerrit based integration. | |
A Gitea based integration. | |
Corresponds to a Github installation which internally could hold several GitHub Apps. | |
A GitHub based integration. | |
A GitLab based integration. | |
A Harness Code based integration. | |
Exposes the set of supported integrations. | |
Handles the creation and caching of credentials for GitHub integrations. |
Functions
Function |
Description |
---|---|
buildGerritGitilesArchiveUrl(config, project, branch, filePath) |
Build a Gerrit Gitiles archive url that targets a specific branch and path |
Default implementation of ScmIntegration | |
Given a URL, return the API URL to fetch commits on the branch. | |
Given a URL pointing to a path on a provider, returns a URL that is suitable for downloading the subtree. | |
Given a URL pointing to a file on a provider, returns a URL that is suitable for fetching the contents of the data. | |
Gets the request options necessary to make requests to a given provider. | |
Given a URL pointing to a path on a provider, returns the default branch. | |
Given a URL pointing to a path on a provider, returns a URL that is suitable for downloading the subtree. | |
Given a URL pointing to a file on a provider, returns a URL that is suitable for fetching the contents of the data. | |
Gets the request options necessary to make requests to a given provider. | |
Given a URL pointing to a path on a provider, returns the default branch. | |
Given a URL pointing to a path on a provider, returns a URL that is suitable for downloading the subtree. | |
Given a URL pointing to a file on a provider, returns a URL that is suitable for fetching the contents of the data. | |
Gets the request options necessary to make requests to a given provider. | |
Given a URL pointing to a path on a provider, returns the default branch. | |
Given a URL pointing to a path on a provider, returns a URL that is suitable for downloading the subtree. | |
Given a URL pointing to a file on a provider, returns a URL that is suitable for fetching the contents of the data. | |
Gets the request options necessary to make requests to a given provider. | |
Return the url to get branch info from the Gerrit API. | |
Return the url to clone the repo that is referenced by the url. | |
Return the url to fetch the contents of a file using the Gerrit API. | |
Return the url to query available projects using the Gerrit API. | |
Return request headers for a Gerrit provider. | |
Given a URL pointing to a repository/path, returns a URL for archive contents of the repository. | |
Given a URL pointing to a file, returns a URL for editing the contents of the data. | |
Given a URL pointing to a file, returns an api URL for fetching the contents of the data. | |
Given a URL pointing to a repository branch, returns a URL for latest commit information. | |
Return request headers for a Gitea provider. | |
Given a URL pointing to a file on a provider, returns a URL that is suitable for fetching the contents of the data. | |
Gets the request options necessary to make requests to a given provider. | |
Given a URL pointing to a file on a provider, returns a URL that is suitable for fetching the contents of the data. | |
Reads a GitLab integration config, and returns relative path. | |
Gets the request options necessary to make requests to a given provider. | |
Given a URL pointing to a repository/path, returns a URL for archive contents of the repository. | |
Given a file path URL, it returns an API URL which returns the contents of the file . | |
Given a URL pointing to a repository branch, returns a URL for latest commit information. | |
Return request headers for a Harness Code provider. | |
Parse a Gitiles URL and return branch, file path and project. | |
Parse the json response from Gerrit and strip the magic prefix. | |
Return parsed git url properties. | |
Parses Gitiles urls and returns the following:
Supported types of gitiles urls that point to:
| |
Return parsed git url properties. | |
Reads a single Aws CodeCommit integration config. | |
Reads a set of AWS CodeCommit integration configs, and inserts some defaults for public Amazon AWS if not specified. | |
Reads a single Aws S3 integration config. | |
Reads a set of AWS S3 integration configs, and inserts some defaults for public Amazon AWS if not specified. | |
Reads a single Azure integration config. | |
Reads a set of Azure integration configs, and inserts some defaults for public Azure if not specified. | |
Reads a single Bitbucket Cloud integration config. | |
Reads a set of Bitbucket Cloud integration configs, and inserts one for public Bitbucket Cloud if none specified. | |
Reads a single Bitbucket integration config. | |
Reads a set of Bitbucket integration configs, and inserts some defaults for public Bitbucket if not specified. | |
Reads a single Bitbucket Server integration config. | |
Reads a set of Bitbucket Server integration configs. | |
Reads a single Gerrit integration config. | |
Reads a set of Gerrit integration configs. | |
Parses a location config block for use in GiteaIntegration | |
Reads a single GitHub integration config. | |
Reads a set of GitHub integration configs, and inserts some defaults for public GitHub if not specified. | |
Reads a single GitLab integration config. | |
Reads a set of GitLab integration configs, and inserts some defaults for public GitLab if not specified. | |
Reads a single Google GCS integration config. | |
Parses a location config block for use in HarnessIntegration | |
Takes a GitHub URL and replaces the type part (blob, tree etc). | |
Takes a GitLab URL and replaces the type part (blob, tree etc). |
Interfaces
Interface |
Description |
---|---|
This allows implementations to be provided to retrieve Azure DevOps credentials. | |
This allows implementations to be provided to retrieve GitHub credentials. | |
The set of supported integrations. | |
Encapsulates information about the RateLimit state | |
Encapsulates a single SCM integration. | |
Holds all registered SCM integrations, of all types. | |
Encapsulates several integrations, that are all of the same type. |
Type Aliases
Type Alias |
Description |
---|---|
The configuration parameters for a single AWS CodeCommit provider. | |
The configuration parameters for a single AWS S3 provider. | |
A client secret credential that was generated for an App Registration. | |
Common fields for the Azure DevOps credentials. | |
Credential used to authenticate to Azure DevOps. | |
The kind of Azure DevOps credential. | |
The general shape of a credential that can be used to authenticate to Azure DevOps. | |
A set of credentials for Azure DevOps. | |
The type of Azure DevOps credential, either bearer or pat. | |
The configuration parameters for a single Azure provider. | |
A managed identity credential. | |
The configuration parameters for a single Bitbucket Cloud API provider. | |
The configuration parameters for a single Bitbucket API provider. | |
The configuration parameters for a single Bitbucket Server API provider. | |
The configuration parameters for a single Gerrit API provider. | |
The configuration for a single Gitea integration. | |
The configuration parameters for authenticating a GitHub Application. | |
A set of credentials information for a GitHub integration. | |
The type of credentials produced by the credential provider. | |
The configuration parameters for a single GitHub integration. | |
The configuration parameters for a single GitLab integration. | |
The configuration parameters for a single Google Cloud Storage provider. | |
The configuration for a single Harness integration. | |
A personal access token credential. | |
A factory function that creates an integration group based on configuration. |