@backstage/integration

What is @backstage/integration?

@backstage/integration is a package that provides a set of utilities and integrations for working with various external systems and services within the Backstage ecosystem. It helps in managing integrations with source control systems, cloud providers, and other external services.

What are @backstage/integration's main functionalities?

GitHub Integration

This feature allows you to integrate with GitHub, enabling you to resolve repository URLs and interact with GitHub repositories using the provided configuration.

const { GithubIntegration } = require('@backstage/integration');
const config = { host: 'github.com', token: 'your-github-token' };
const githubIntegration = GithubIntegration.fromConfig(config);
const repoUrl = 'https://github.com/your-org/your-repo';
const repoDetails = githubIntegration.resolveUrl({ url: repoUrl });
console.log(repoDetails);

GitLab Integration

This feature allows you to integrate with GitLab, enabling you to resolve repository URLs and interact with GitLab repositories using the provided configuration.

const { GitlabIntegration } = require('@backstage/integration');
const config = { host: 'gitlab.com', token: 'your-gitlab-token' };
const gitlabIntegration = GitlabIntegration.fromConfig(config);
const repoUrl = 'https://gitlab.com/your-org/your-repo';
const repoDetails = gitlabIntegration.resolveUrl({ url: repoUrl });
console.log(repoDetails);

Bitbucket Integration

This feature allows you to integrate with Bitbucket, enabling you to resolve repository URLs and interact with Bitbucket repositories using the provided configuration.

const { BitbucketIntegration } = require('@backstage/integration');
const config = { host: 'bitbucket.org', token: 'your-bitbucket-token' };
const bitbucketIntegration = BitbucketIntegration.fromConfig(config);
const repoUrl = 'https://bitbucket.org/your-org/your-repo';
const repoDetails = bitbucketIntegration.resolveUrl({ url: repoUrl });
console.log(repoDetails);

Azure DevOps Integration

This feature allows you to integrate with Azure DevOps, enabling you to resolve repository URLs and interact with Azure DevOps repositories using the provided configuration.

const { AzureIntegration } = require('@backstage/integration');
const config = { host: 'dev.azure.com', token: 'your-azure-token' };
const azureIntegration = AzureIntegration.fromConfig(config);
const repoUrl = 'https://dev.azure.com/your-org/your-repo';
const repoDetails = azureIntegration.resolveUrl({ url: repoUrl });
console.log(repoDetails);

Other packages similar to @backstage/integration

octokit

Octokit is a GitHub API client for JavaScript. It provides a comprehensive set of tools for interacting with the GitHub API, including repository management, issue tracking, and more. Compared to @backstage/integration, Octokit is more focused on GitHub-specific functionalities.

node-gitlab

Node-GitLab is a GitLab API client for Node.js. It allows you to interact with GitLab's API to manage repositories, issues, and other resources. While @backstage/integration provides a broader set of integrations, node-gitlab is specialized for GitLab.

bitbucket

Bitbucket is an API client for Bitbucket's REST API. It enables you to manage repositories, pull requests, and other resources on Bitbucket. Compared to @backstage/integration, the bitbucket package is dedicated to Bitbucket-specific operations.

azure-devops-node-api

Azure DevOps Node API is a client library for interacting with Azure DevOps services. It provides tools for managing repositories, pipelines, and other Azure DevOps resources. While @backstage/integration supports multiple integrations, azure-devops-node-api is focused on Azure DevOps.

README

Integrations common functionality

Contains some common functionality of integrations.

This package will be imported both by the frontend and backend.

Links

• The Backstage homepage