ScmIntegration
Home > @backstage/integration
> ScmIntegration
Encapsulates a single SCM integration.
Signature:
export interface ScmIntegration
Properties
Property |
Modifiers |
Type |
Description |
---|---|---|---|
string |
A human readable title for the integration, that can be shown to users to differentiate between different integrations. | ||
string |
The type of integration, e.g. "github". |
Methods
Method |
Description |
---|---|
Resolves the edit URL for a file within the SCM system. Most SCM systems have a web interface that allows viewing and editing files in the repository. The returned URL directly jumps into the edit mode for the file. If this is not possible, the integration can fall back to a URL to view the file in the web interface. | |
Resolves an absolute or relative URL in relation to a base URL. This method is adapted for use within SCM systems, so relative URLs are within the context of the root of the hierarchy pointed to by the base URL. For example, if the base URL is |