paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
backstage/packages/integration/CHANGELOG.md
T
github-actions[bot] 68db890456 Version Packages (next)
2026-05-26 15:26:38 +00:00

60 KiB
Raw Permalink Blame History

@backstage/integration

2.0.3-next.0

Patch Changes

  • a07e6a3: Added the correctly-spelled AzureBlobStorageIntegration class export and deprecated the previous typoed AzureBlobStorageIntergation export. Existing usage of AzureBlobStorageIntergation continues to work; switch to AzureBlobStorageIntegration to avoid future removal.

2.0.2

Patch Changes

  • 6b112d3: Fixed two issues in the GitLab integration's fetch behavior:

    • The internal fetch wrapper was passing mode: 'same-origin' on every request. This had no practical effect server-side, but would have caused cross-origin requests to be rejected when the integration is used from a browser. Requests now use the default fetch mode and work correctly in both browser and Node environments.
    • When retries are configured, transient network errors (such as dropped connections or DNS hiccups) are now retried using the same maxRetries and exponential delay as retryable HTTP status codes. Previously, a thrown fetch error would propagate immediately on the first failure regardless of the retry configuration. Caller-initiated aborts continue to surface immediately without being retried.

  • b62781f: Moved registerMswTestHooks to test files.

  • Updated dependencies

    • @backstage/errors@1.3.1
    • @backstage/config@1.3.8

2.0.2-next.1

Patch Changes

  • 6b112d3: Fixed two issues in the GitLab integration's fetch behavior:

    • The internal fetch wrapper was passing mode: 'same-origin' on every request. This had no practical effect server-side, but would have caused cross-origin requests to be rejected when the integration is used from a browser. Requests now use the default fetch mode and work correctly in both browser and Node environments.
    • When retries are configured, transient network errors (such as dropped connections or DNS hiccups) are now retried using the same maxRetries and exponential delay as retryable HTTP status codes. Previously, a thrown fetch error would propagate immediately on the first failure regardless of the retry configuration. Caller-initiated aborts continue to surface immediately without being retried.

2.0.2-next.0

Patch Changes

  • b62781f: Moved registerMswTestHooks to test files.
  • Updated dependencies
    • @backstage/errors@1.3.1-next.0
    • @backstage/config@1.3.8-next.0

2.0.1

Patch Changes

  • d112499: Fixed SingleInstanceGithubCredentialsProvider to return app credentials when getCredentials is called with a bare host URL (e.g. https://github.com) instead of falling back to a personal access token.
  • Updated dependencies
    • @backstage/errors@1.3.0
    • @backstage/config@1.3.7

2.0.1-next.0

Patch Changes

  • d112499: Fixed SingleInstanceGithubCredentialsProvider to return app credentials when getCredentials is called with a bare host URL (e.g. https://github.com) instead of falling back to a personal access token.
  • Updated dependencies
    • @backstage/errors@1.3.0-next.0
    • @backstage/config@1.3.7-next.0

2.0.0

Major Changes

  • 527cf88: BREAKING Removed deprecated Azure DevOps, Bitbucket, Gerrit and GitHub code:

    • For Azure DevOps, the long deprecated token string and credential object have been removed from the config.d.ts. Use the credentials array object instead.
    • For Bitbucket, the long deprecated bitbucket object has been removed from the config.d.ts. Use the bitbucketCloud or bitbucketServer objects instead.
    • For Gerrit, the parseGerritGitilesUrl function has been removed, use parseGitilesUrlRef instead. The buildGerritGitilesArchiveUrl function has also been removed, use buildGerritGitilesArchiveUrlFromLocation instead.
    • For GitHub, the getGitHubRequestOptions function has been removed.

Minor Changes

  • d933f62: Add configurable throttling and retry mechanism for GitLab integration.

Patch Changes

  • 1513a0b: Fixed a security vulnerability where path traversal sequences in SCM URLs could be used to access unintended API endpoints using server-side integration credentials.
  • 993a598: Fixed Azure integration config schema visibility annotations to use per-field @visibility secret instead of @deepVisibility secret on parent objects, so that non-secret fields like clientId, tenantId, organizations, and managedIdentityClientId are no longer incorrectly marked as secret.

2.0.0-next.2

Patch Changes

  • 1513a0b: Fixed a security vulnerability where path traversal sequences in SCM URLs could be used to access unintended API endpoints using server-side integration credentials.

2.0.0-next.1

Major Changes

  • 527cf88: BREAKING Removed deprecated Azure DevOps, Bitbucket, Gerrit and GitHub code:

    • For Azure DevOps, the long deprecated token string and credential object have been removed from the config.d.ts. Use the credentials array object instead.
    • For Bitbucket, the long deprecated bitbucket object has been removed from the config.d.ts. Use the bitbucketCloud or bitbucketServer objects instead.
    • For Gerrit, the parseGerritGitilesUrl function has been removed, use parseGitilesUrlRef instead. The buildGerritGitilesArchiveUrl function has also been removed, use buildGerritGitilesArchiveUrlFromLocation instead.
    • For GitHub, the getGitHubRequestOptions function has been removed.

Patch Changes

  • 993a598: Fixed Azure integration config schema visibility annotations to use per-field @visibility secret instead of @deepVisibility secret on parent objects, so that non-secret fields like clientId, tenantId, organizations, and managedIdentityClientId are no longer incorrectly marked as secret.
  • Updated dependencies
    • @backstage/config@1.3.6
    • @backstage/errors@1.2.7

1.21.0-next.0

Minor Changes

  • d933f62: Add configurable throttling and retry mechanism for GitLab integration.

Patch Changes

  • Updated dependencies
    • @backstage/config@1.3.6
    • @backstage/errors@1.2.7

1.20.0

Minor Changes

  • 6999f6d: The AzureUrl class in the @backstage/integration package is now able to process BOTH git branches and git tags. Initially this class only processed git branches and threw an error when non-branch Azure URLs were passed in.

Patch Changes

  • cc6206e: Added support for {org}.visualstudio.com domains used by Azure DevOps
  • 7455dae: Use node prefix on native imports

1.20.0-next.2

Patch Changes

  • cc6206e: Added support for {org}.visualstudio.com domains used by Azure DevOps

1.20.0-next.1

Minor Changes

  • 6999f6d: The AzureUrl class in the @backstage/integration package is now able to process BOTH git branches and git tags. Initially this class only processed git branches and threw an error when non-branch Azure URLs were passed in.

1.19.3-next.0

Patch Changes

  • 7455dae: Use node prefix on native imports
  • Updated dependencies
    • @backstage/config@1.3.6
    • @backstage/errors@1.2.7

1.19.2

Patch Changes

  • 3afeab4: Implementing ScmIntegration for GoogleGcs
  • 9083273: Rollback the lowercase replacing in GitHub integration config

1.19.2-next.0

Patch Changes

  • 3afeab4: Implementing ScmIntegration for GoogleGcs
  • 9083273: Rollback the lowercase replacing in GitHub integration config

1.19.0

Minor Changes

  • 37fba1d: Added support for Bitbucket Cloud OAuth. This introduces an alternative authentication method using a workspace OAuth consumer, alongside App Passwords (deprecated) and API tokens. OAuth does not require a bot or service account and avoids token expiry issues.

    BREAKING CHANGES

    • @backstage/integration (src/bitbucketCloud/core.ts)

      • getBitbucketCloudRequestOptions now returns a Promise and must be awaited.

    • @backstage/plugin-scaffolder-backend-module-bitbucket-cloud (src/actions/helpers.ts)

      • getBitbucketClient now returns a Promise and must be awaited.
      • getAuthorizationHeader now returns a Promise and must be awaited.

    OAuth usage example

    integrations:
  bitbucketCloud:
    - clientId: client-id
      clientSecret: client-secret

Patch Changes

  • a26a322: Added support for using a GitHub App installation to generate tokens for public repository access when the publicAccess option is enabled. When all other authentication methods fail (e.g., the app is not installed in that organization), the provider will now use an available installation to generate a token that can be used to access public repositories as read only.
  • fb029b6: Updated luxon types
  • e15fdae: Made the github urls case insensitive.

1.18.3-next.1

Patch Changes

  • fb029b6: Updated luxon types
  • Updated dependencies
    • @backstage/config@1.3.6
    • @backstage/errors@1.2.7

1.18.3-next.0

Patch Changes

  • e15fdae: Made the github urls case insensitive.
  • Updated dependencies
    • @backstage/config@1.3.6
    • @backstage/errors@1.2.7

1.18.2

Patch Changes

  • fa255f5: Support for Bitbucket Cloud's API token was added as appPassword is deprecated (no new creation from September 9, 2025) and will be removed on June 9, 2026.

    API token usage example:

    integrations:
  bitbucketCloud:
    - username: user@domain.com
      token: my-token

  • 05f60e1: Refactored constructor parameter properties to explicit property declarations for compatibility with TypeScript's erasableSyntaxOnly setting. This internal refactoring maintains all existing functionality while ensuring TypeScript compilation compatibility.

  • Updated dependencies

    • @backstage/config@1.3.6

1.18.2-next.0

Patch Changes

  • 05f60e1: Refactored constructor parameter properties to explicit property declarations for compatibility with TypeScript's erasableSyntaxOnly setting. This internal refactoring maintains all existing functionality while ensuring TypeScript compilation compatibility.
  • Updated dependencies
    • @backstage/config@1.3.6-next.0
    • @backstage/errors@1.2.7

1.18.1

Patch Changes

  • d772b51: remove host from azure blob storage integration type
  • 84443f1: Adds config definitions for Azure Blob Storage.
  • Updated dependencies
    • @backstage/config@1.3.5

1.18.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/config@1.3.4-next.0

1.18.1-next.0

Patch Changes

  • d772b51: remove host from azure blob storage integration type
  • 84443f1: Adds config definitions for Azure Blob Storage.
  • Updated dependencies
    • @backstage/config@1.3.3
    • @backstage/errors@1.2.7

1.18.0

Minor Changes

  • 03bdc68: Added support for limiting GithubAppCredentialsMux to specific apps

Patch Changes

  • 56897d7: Fixes issue with Github credentials provider which fails to match organization name if using allowedInstallationOwners

1.18.0-next.0

Minor Changes

  • 03bdc68: Added support for limiting GithubAppCredentialsMux to specific apps

1.17.1

Patch Changes

  • e0189b8: UrlReader: Fix handling of access tokens for GitLab readURL requests
  • d1e4a6d: Fixed bug where the GitLab user token and GitLab integration token were being merged together
  • Updated dependencies
    • @backstage/config@1.3.3

1.17.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/config@1.3.3-next.0

1.17.1-next.0

Patch Changes

  • e0189b8: UrlReader: Fix handling of access tokens for GitLab readURL requests
  • d1e4a6d: Fixed bug where the GitLab user token and GitLab integration token were being merged together
  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.17.0

Minor Changes

  • d945206: Added support for federated credentials using managed identities in the Azure DevOps integration. Federated credentials are only available for Azure DevOps organizations that have been configured to use Entra ID for authentication.

    integrations:
  azure:
    - host: dev.azure.com
      credentials:
+       - clientId: ${APP_REGISTRATION_CLIENT_ID}
+         managedIdentityClientId: system-assigned
+         tenantId: ${AZURE_TENANT_ID}

    This also adds support for automatically using the system-assigned managed identity of an Azure resource by specifying system-assigned as the client ID of the managed identity.

    integrations:
  azure:
    - host: dev.azure.com
      credentials:
-       - clientId: ${AZURE_CLIENT_ID}
+       - clientId: system-assigned

  • f134cea: Implement Edit URL feature for Gerrit 3.9+.

    It's possible to disable the edit url by adding the disableEditUrl: true config in the Gerrit integration.

Patch Changes

  • f3381d3: Added missing organizations property to azure section in config.d.ts file
  • acea1d4: update documentation
  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.17.0-next.3

Minor Changes

  • d945206: Added support for federated credentials using managed identities in the Azure DevOps integration. Federated credentials are only available for Azure DevOps organizations that have been configured to use Entra ID for authentication.

    integrations:
  azure:
    - host: dev.azure.com
      credentials:
+       - clientId: ${APP_REGISTRATION_CLIENT_ID}
+         managedIdentityClientId: system-assigned
+         tenantId: ${AZURE_TENANT_ID}

    This also adds support for automatically using the system-assigned managed identity of an Azure resource by specifying system-assigned as the client ID of the managed identity.

    integrations:
  azure:
    - host: dev.azure.com
      credentials:
-       - clientId: ${AZURE_CLIENT_ID}
+       - clientId: system-assigned

Patch Changes

  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.17.0-next.2

Minor Changes

  • f134cea: Implement Edit URL feature for Gerrit 3.9+.

    It's possible to disable the edit url by adding the disableEditUrl: true config in the Gerrit integration.

Patch Changes

  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.16.4-next.1

Patch Changes

  • acea1d4: update documentation
  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.16.4-next.0

Patch Changes

  • f3381d3: Added missing organizations property to azure section in config.d.ts file
  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.16.3

Patch Changes

  • 9768992: Mark GitHub webhookSecret config property as optional. A webhookSecret is not required when creating a GitHub App.
  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.16.3-next.0

Patch Changes

  • 9768992: Mark GitHub webhookSecret config property as optional. A webhookSecret is not required when creating a GitHub App.
  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.16.2

Patch Changes

  • 89db8b8: Gerrit integration now exports getGitilesAuthenticationUrl. This enables its usage by the GerritUrlReader.
  • 4f8b5b6: Allow signing git commits using configured private PGP key in scaffolder
  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.16.2-next.0

Patch Changes

  • 4f8b5b6: Allow signing git commits using configured private PGP key in scaffolder
  • Updated dependencies
    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.16.1

Patch Changes

  • d2b16db: A new Gerrit helper function (buildGerritGitilesArchiveUrlFromLocation) has been added. This constructs a Gitiles URL to download an archive. It is similar to the existing buildGerritGitilesArchiveUrl but also support content referenced by a full commit SHA.

    DEPRECATIONS: The function buildGerritGitilesArchiveUrl is deprecated, use the buildGerritGitilesArchiveUrlFromLocation function instead.

    DEPRECATIONS: The function parseGerritGitilesUrl is deprecated, use the parseGitilesUrlRef function instead.

  • Updated dependencies

    • @backstage/config@1.3.2
    • @backstage/errors@1.2.7

1.16.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/config@1.3.2-next.0
    • @backstage/errors@1.2.7-next.0

1.16.0

Minor Changes

  • 277092a: Add the integration for Azure blob storage to read the credentials to access the storage account and provide the default credential provider.

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.2.6
    • @backstage/config@1.3.1

1.16.0-next.1

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.2.6-next.0
    • @backstage/config@1.3.1-next.0

1.16.0-next.0

Minor Changes

  • 277092a: Add the integration for Azure blob storage to read the credentials to access the storage account and provide the default credential provider.

Patch Changes

  • Updated dependencies
    • @backstage/config@1.3.0
    • @backstage/errors@1.2.5

1.15.2

Patch Changes

  • Updated dependencies
    • @backstage/config@1.3.0
    • @backstage/errors@1.2.5

1.15.1

Patch Changes

  • 720a2f9: Updated dependency git-url-parse to ^15.0.0.
  • 920004b: Updating error message for getProjectId when fetching Gitlab project from its url to be more accurate
  • 090e49a: Updated functions parseHarnessUrl, getHarnessLatestCommitUrl, getHarnessFileContentsUrl and getHarnessArchiveUrl to fix parsing of urls
  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.15.1-next.1

Patch Changes

  • 720a2f9: Updated dependency git-url-parse to ^15.0.0.
  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.15.1-next.0

Patch Changes

  • 920004b: Updating error message for getProjectId when fetching Gitlab project from its url to be more accurate
  • 090e49a: Updated functions parseHarnessUrl, getHarnessLatestCommitUrl, getHarnessFileContentsUrl and getHarnessArchiveUrl to fix parsing of urls
  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.15.0

Minor Changes

  • 1573014: The Gerrit integration can now resolve Gitiles urls that point to the following refs:

    • HEAD
    • A SHA
    • Tag
    • Branch

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.15.0-next.0

Minor Changes

  • 1573014: The Gerrit integration can now resolve Gitiles urls that point to the following refs:

    • HEAD
    • A SHA
    • Tag
    • Branch

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.14.0

Minor Changes

  • 78c1329: Updated GitlabUrlReader.readUrl and GitlabUrlReader.readTree to accept a user-provided token, supporting both bearer and private tokens.

Patch Changes

  • c591670: Updated functions for getHarnessEditContentsUrl, getHarnessFileContentsUrl, getHarnessArchiveUrl, getHarnessLatestCommitUrl and parseHarnessUrl to handle account and org level urls
  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.14.0-next.0

Minor Changes

  • 78c1329: Updated GitlabUrlReader.readUrl and GitlabUrlReader.readTree to accept a user-provided token, supporting both bearer and private tokens.

Patch Changes

  • c591670: Updated functions for getHarnessEditContentsUrl, getHarnessFileContentsUrl, getHarnessArchiveUrl, getHarnessLatestCommitUrl and parseHarnessUrl to handle account and org level urls
  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.13.0

Minor Changes

  • b5deed0: Add support for token for bitbucketCloud integration

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.13.0-next.0

Minor Changes

  • b5deed0: Add support for token for bitbucketCloud integration

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.12.0

Minor Changes

  • be1014d: BREAKING Removed deprecated code from when casing was changed from GitHub to Github nearly two years ago. The following items have been removed:

    • getGitHubFileFetchUrl (use getGithubFileFetchUrl instead)
    • GitHubIntegrationConfig (use GithubIntegrationConfig instead)
    • GitHubIntegration (use GithubIntegration instead)
    • readGitHubIntegrationConfig (use readGithubIntegrationConfig instead)
    • readGitHubIntegrationConfigs (use readGithubIntegrationConfigs instead)
    • replaceGitHubUrlType (use replaceGithubUrlType instead)

  • 395b973: Implemented readTree for Harness provider to support TechDocs functionality

  • 662dce8: BREAKING: gitilesBaseUrl is now mandatory for the Gerrit integration. The ability to override this requirement using the DISABLE_GERRIT_GITILES_REQUIREMENT environment variable has been removed.

Patch Changes

  • 509e08c: Updated function for getHarnessEditContentsUrl
  • 23ee9ab: Fix AWS CodeCommit integration by allowing to change the host
  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.12.0-next.1

Minor Changes

  • be1014d: BREAKING Removed deprecated code from when casing was changed from GitHub to Github nearly two years ago. The following items have been removed:

    • getGitHubFileFetchUrl (use getGithubFileFetchUrl instead)
    • GitHubIntegrationConfig (use GithubIntegrationConfig instead)
    • GitHubIntegration (use GithubIntegration instead)
    • readGitHubIntegrationConfig (use readGithubIntegrationConfig instead)
    • readGitHubIntegrationConfigs (use readGithubIntegrationConfigs instead)
    • replaceGitHubUrlType (use replaceGithubUrlType instead)

Patch Changes

  • 23ee9ab: Fix AWS CodeCommit integration by allowing to change the host
  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.12.0-next.0

Minor Changes

  • 395b973: Implemented readTree for Harness provider to support TechDocs functionality

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.11.0

Minor Changes

  • 2cc750d: Added HarnessIntegration via the ScmIntegrations interface.

1.11.0-next.0

Minor Changes

  • 2cc750d: Added HarnessIntegration via the ScmIntegrations interface.

1.10.0

Minor Changes

  • 7b11422: Add AWS CodeCommit URL Reader/Integration

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.10.0-next.0

Minor Changes

  • 7b11422: Add AWS CodeCommit URL Reader/Integration

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.9.1

Patch Changes

  • 0386fa7: Fixed an issue with resolution of SCM URLs against a base URL with a trailing slash.
  • Updated dependencies
    • @backstage/config@1.2.0
    • @backstage/errors@1.2.4

1.9.1-next.2

Patch Changes

  • 0386fa7: Fixed an issue with resolution of SCM URLs against a base URL with a trailing slash.
  • Updated dependencies
    • @backstage/config@1.2.0-next.1
    • @backstage/errors@1.2.4-next.0

1.9.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/config@1.2.0-next.1
    • @backstage/errors@1.2.4-next.0

1.9.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.2.4-next.0
    • @backstage/config@1.1.2-next.0

1.9.0

Minor Changes

  • e27b7f3: Fix rate limit detection by looking for HTTP status code 429 and updating the header x-ratelimit-remaining to look for in case of a 403 code is returned

Patch Changes

  • 6d898f7: All single-line secrets read from config will now have both leading and trailing whitespace trimmed. This is done to ensure that the secrets are always valid HTTP header values, since many fetch implementations will include the header value itself when an error is thrown due to invalid header values.
  • 1cae748: Updated dependency git-url-parse to ^14.0.0.
  • 2d0e7cd: Validate if the baseUrl is a valid URL
  • Updated dependencies
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

1.9.0-next.1

Patch Changes

  • 6d898f7: All single-line secrets read from config will now have both leading and trailing whitespace trimmed. This is done to ensure that the secrets are always valid HTTP header values, since many fetch implementations will include the header value itself when an error is thrown due to invalid header values.
  • 1cae748: Updated dependency git-url-parse to ^14.0.0.
  • Updated dependencies
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

1.9.0-next.0

Minor Changes

  • e27b7f3: Fix rate limit detection by looking for HTTP status code 429 and updating the header x-ratelimit-remaining to look for in case of a 403 code is returned

Patch Changes

  • Updated dependencies
    • @backstage/config@1.1.1
    • @backstage/errors@1.2.3

1.8.0

Minor Changes

  • 870db76: Implemented readTree for Gitea provider to support TechDocs functionality

Patch Changes

  • 99fb541: Updated dependency @azure/identity to ^4.0.0.
  • Updated dependencies
    • @backstage/config@1.1.1

1.8.0-next.1

Patch Changes

  • 99fb54183b: Updated dependency @azure/identity to ^4.0.0.
  • Updated dependencies
    • @backstage/config@1.1.1

1.8.0-next.0

Minor Changes

  • 870db76a45: Implemented readTree for Gitea provider to support TechDocs functionality

Patch Changes

  • Updated dependencies
    • @backstage/config@1.1.1

1.7.2

Patch Changes

  • 243c655a68: JSDoc and Error message updates to handle Azure Active Directory re-brand to Entra ID
  • 4aa43f62aa: Updated dependency cross-fetch to ^4.0.0.
  • Updated dependencies
    • @backstage/config@1.1.1

1.7.2-next.0

Patch Changes

  • 243c655a68: JSDoc and Error message updates to handle Azure Active Directory re-brand to Entra ID
  • Updated dependencies
    • @backstage/config@1.1.1

1.7.1

Patch Changes

  • 3963d0b885: Ensure that all relevant config fields are properly marked as secret
  • 0b55f773a7: Removed some unused dependencies
  • Updated dependencies
    • @backstage/config@1.1.1

1.7.1-next.1

Patch Changes

  • 0b55f773a7: Removed some unused dependencies
  • Updated dependencies
    • @backstage/config@1.1.1-next.0

1.7.1-next.0

Patch Changes

  • 3963d0b885: Ensure that all relevant config fields are properly marked as secret
  • Updated dependencies
    • @backstage/config@1.1.0
    • @backstage/errors@1.2.2

1.7.0

Minor Changes

  • 5f1a92b9f1: Added AzureDevOpsCredentialsProvider to support multiple Azure DevOps organizations and deprecated AzureIntegrationConfig.credential and AzureIntegrationConfig.token in favour of AzureIntegrationConfig.credentials. You can now use specific credentials for different Azure DevOps (Server) organizations by specifying the organizations field on a credential:

    integrations:
  azure:
    - host: dev.azure.com
      credentials:
        - organizations:
            - my-org
            - my-other-org
          clientId: ${AZURE_CLIENT_ID}
          clientSecret: ${AZURE_CLIENT_SECRET}
          tenantId: ${AZURE_TENANT_ID}
        - organizations:
            - yet-another-org
          personalAccessToken: ${PERSONAL_ACCESS_TOKEN}

    See the Azure integration documentation for more information.

Patch Changes

  • 406b786a2a: Mark package as being free of side effects, allowing more optimized Webpack builds.
  • 2d2fc9d20e: Additional fix for Gitiles auth links
  • cb2e19d82d: Gitiles: Fixed auth prefix issue
  • Updated dependencies
    • @backstage/config@1.1.0
    • @backstage/errors@1.2.2

1.7.0-next.3

Patch Changes

  • 406b786a2a: Mark package as being free of side effects, allowing more optimized Webpack builds.
  • Updated dependencies
    • @backstage/config@1.1.0-next.2
    • @backstage/errors@1.2.2-next.0

1.7.0-next.2

Patch Changes

  • Updated dependencies
    • @backstage/config@1.1.0-next.1
    • @backstage/errors@1.2.1

1.7.0-next.1

Patch Changes

  • 2d2fc9d20e: Additional fix for Gitiles auth links
  • Updated dependencies
    • @backstage/config@1.1.0-next.0
    • @backstage/errors@1.2.1

1.7.0-next.0

Minor Changes

  • 5f1a92b9f1: Added AzureDevOpsCredentialsProvider to support multiple Azure DevOps organizations and deprecated AzureIntegrationConfig.credential and AzureIntegrationConfig.token in favour of AzureIntegrationConfig.credentials. You can now use specific credentials for different Azure DevOps (Server) organizations by specifying the organizations field on a credential:

    integrations:
  azure:
    - host: dev.azure.com
      credentials:
        - organizations:
            - my-org
            - my-other-org
          clientId: ${AZURE_CLIENT_ID}
          clientSecret: ${AZURE_CLIENT_SECRET}
          tenantId: ${AZURE_TENANT_ID}
        - organizations:
            - yet-another-org
          personalAccessToken: ${PERSONAL_ACCESS_TOKEN}

    See the Azure integration documentation for more information.

Patch Changes

  • cb2e19d82d: Gitiles: Fixed auth prefix issue
  • Updated dependencies
    • @backstage/config@1.0.8
    • @backstage/errors@1.2.1

1.6.0

Minor Changes

  • 443afcf7f5: Added buildGerritGitilesArchiveUrl() to construct a Gitiles URL to download an archive. Gitiles URL that uses an authenticated prefix (/a/) can now be parsed by the integration.

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.8
    • @backstage/errors@1.2.1

1.5.1

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.2.1
    • @backstage/config@1.0.8

1.5.1-next.0

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.2.1-next.0
    • @backstage/config@1.0.8

1.5.0

Minor Changes

  • a316d226c7: Add credential provider for GitLab.

  • c7f848bcea: Support authentication with a service principal or managed identity for Azure DevOps

    Azure DevOps recently released support, in public preview, for authenticating with a service principal or managed identity instead of a personal access token (PAT): https://devblogs.microsoft.com/devops/introducing-service-principal-and-managed-identity-support-on-azure-devops/. With this change the Azure integration now supports service principals and managed identities for Azure AD backed Azure DevOps organizations. Service principal and managed identity authentication is not supported on Azure DevOps Server (on-premises) organizations.

Patch Changes

  • 3c83550fdb: Renamed ClientSecret to AzureClientSecretCredential and ManagedIdentity to AzureManagedIdentityCredential

  • df8411779d: Add support for Repository Variables and Secrets to the publish:github and github:repo:create scaffolder actions. You will need to add read/write permissions to your GITHUB_TOKEN and/or Github Backstage App for Repository Secrets and Variables

    Upgrade octokit introduces some breaking changes.

  • Updated dependencies

    • @backstage/errors@1.2.0
    • @backstage/config@1.0.8

1.5.0-next.0

Minor Changes

  • a316d226c7: Add credential provider for GitLab.

  • c7f848bcea: Support authentication with a service principal or managed identity for Azure DevOps

    Azure DevOps recently released support, in public preview, for authenticating with a service principal or managed identity instead of a personal access token (PAT): https://devblogs.microsoft.com/devops/introducing-service-principal-and-managed-identity-support-on-azure-devops/. With this change the Azure integration now supports service principals and managed identities for Azure AD backed Azure DevOps organizations. Service principal and managed identity authentication is not supported on Azure DevOps Server (on-premises) organizations.

Patch Changes

  • df8411779d: Add support for Repository Variables and Secrets to the publish:github and github:repo:create scaffolder actions. You will need to add read/write permissions to your GITHUB_TOKEN and/or Github Backstage App for Repository Secrets and Variables

    Upgrade octokit introduces some breaking changes.

  • Updated dependencies

    • @backstage/errors@1.2.0-next.0
    • @backstage/config@1.0.7

1.4.5

Patch Changes

  • b026275bcc: Fixed a bug where the wrong credentials would be selected when using multiple GitHub app integrations.
  • Updated dependencies
    • @backstage/config@1.0.7
    • @backstage/errors@1.1.5

1.4.5-next.0

Patch Changes

  • b026275bcc: Fixed a bug where the wrong credentials would be selected when using multiple GitHub app integrations.
  • Updated dependencies
    • @backstage/config@1.0.7
    • @backstage/errors@1.1.5

1.4.4

Patch Changes

  • e0c6e8b9c3: Update peer dependencies
  • Updated dependencies
    • @backstage/config@1.0.7
    • @backstage/errors@1.1.5

1.4.4-next.0

Patch Changes

  • e0c6e8b9c3: Update peer dependencies
  • Updated dependencies
    • @backstage/config@1.0.7
    • @backstage/errors@1.1.5

1.4.3

Patch Changes

  • 52b0022dab: Updated dependency msw to ^1.0.0.
  • Updated dependencies
    • @backstage/errors@1.1.5
    • @backstage/config@1.0.7

1.4.3-next.0

Patch Changes

  • 52b0022dab: Updated dependency msw to ^1.0.0.
  • Updated dependencies
    • @backstage/errors@1.1.5-next.0
    • @backstage/config@1.0.7-next.0

1.4.2

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.6
    • @backstage/errors@1.1.4

1.4.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.6-next.0
    • @backstage/errors@1.1.4

1.4.1

Patch Changes

  • 3280711113: Updated dependency msw to ^0.49.0.
  • 34b039ca9f: Added integrations.github.apps.allowedInstallationOwners to the configuration schema.
  • Updated dependencies
    • @backstage/errors@1.1.4
    • @backstage/config@1.0.5

1.4.1-next.1

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.5-next.1
    • @backstage/errors@1.1.4-next.1

1.4.1-next.0

Patch Changes

  • 3280711113: Updated dependency msw to ^0.49.0.
  • 34b039ca9f: Added integrations.github.apps.allowedInstallationOwners to the configuration schema.
  • Updated dependencies
    • @backstage/config@1.0.5-next.0
    • @backstage/errors@1.1.4-next.0

1.4.0

Minor Changes

  • d05e1841ce: This patch brings Gitea as a valid integration: target, via the ScmIntegration interface. It adds gitea to the relevant static properties (get integration by name, get integration by type) for plugins to be able to reference the same Gitea server.

  • c1784a4980: Replaces in-code uses of GitHub with Github and deprecates old versions.

    Deprecates:

    • getGitHubFileFetchUrl replaced by getGithubFileFetchUrl
    • GitHubIntegrationConfig replaced by GithubIntegrationConfig
    • GitHubIntegration replaced by GithubIntegration
    • readGitHubIntegrationConfig replaced by readGithubIntegrationConfig
    • readGitHubIntegrationConfigs replaced by readGithubIntegrationConfigs
    • replaceGitHubUrlType replaced by replaceGithubUrlType

Patch Changes

  • 7573b65232: Internal refactor of imports to avoid circular dependencies

  • a6d779d58a: Remove explicit default visibility at config.d.ts files.

    /**
 * @visibility backend
 */

  • Updated dependencies

    • @backstage/config@1.0.4
    • @backstage/errors@1.1.3

1.4.0-next.0

Minor Changes

  • d05e1841ce: This patch brings Gitea as a valid integration: target, via the ScmIntegration interface. It adds gitea to the relevant static properties (get integration by name, get integration by type) for plugins to be able to reference the same Gitea server.

  • c1784a4980: Replaces in-code uses of GitHub with Github and deprecates old versions.

    Deprecates:

    • getGitHubFileFetchUrl replaced by getGithubFileFetchUrl
    • GitHubIntegrationConfig replaced by GithubIntegrationConfig
    • GitHubIntegration replaced by GithubIntegration
    • readGitHubIntegrationConfig replaced by readGithubIntegrationConfig
    • readGitHubIntegrationConfigs replaced by readGithubIntegrationConfigs
    • replaceGitHubUrlType replaced by replaceGithubUrlType

Patch Changes

  • 7573b65232: Internal refactor of imports to avoid circular dependencies

  • a6d779d58a: Remove explicit default visibility at config.d.ts files.

    /**
 * @visibility backend
 */

  • Updated dependencies

    • @backstage/config@1.0.4-next.0
    • @backstage/errors@1.1.3-next.0

1.3.2

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.3
    • @backstage/errors@1.1.2

1.3.2-next.2

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.3-next.2
    • @backstage/errors@1.1.2-next.2

1.3.2-next.1

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.3-next.1
    • @backstage/errors@1.1.2-next.1

1.3.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.3-next.0
    • @backstage/errors@1.1.2-next.0

1.3.1

Patch Changes

  • eadf56bbbf: Bump git-url-parse version to ^13.0.0
  • 7d47def9c4: Removed dependency on @types/jest.
  • 667d917488: Updated dependency msw to ^0.47.0.
  • 87ec2ba4d6: Updated dependency msw to ^0.46.0.
  • bf5e9030eb: Updated dependency msw to ^0.45.0.
  • 42918e085c: Fixed bug in the bitbucketServer integration where token did not take precedence over supplied username and password which is described in the documentation.
  • f76f22c649: Improved caching around github app tokens. Tokens are now cached for 50 minutes, not 10. Calls to get app installations are also included in this cache. If you have more than one github app configured, consider adding allowedInstallationOwners to your apps configuration to gain the most benefit from these performance changes.
  • Updated dependencies
    • @backstage/config@1.0.2
    • @backstage/errors@1.1.1

1.3.1-next.2

Patch Changes

  • 7d47def9c4: Removed dependency on @types/jest.
  • f76f22c649: Improved caching around github app tokens. Tokens are now cached for 50 minutes, not 10. Calls to get app installations are also included in this cache. If you have more than one github app configured, consider adding allowedInstallationOwners to your apps configuration to gain the most benefit from these performance changes.
  • Updated dependencies
    • @backstage/config@1.0.2-next.0
    • @backstage/errors@1.1.1-next.0

1.3.1-next.1

Patch Changes

  • eadf56bbbf: Bump git-url-parse version to ^13.0.0
  • 667d917488: Updated dependency msw to ^0.47.0.
  • 87ec2ba4d6: Updated dependency msw to ^0.46.0.
  • 42918e085c: Fixed bug in the bitbucketServer integration where token did not take precedence over supplied username and password which is described in the documentation.

1.3.1-next.0

Patch Changes

1.3.0

Minor Changes

  • 593dea6710: Add support for Basic Auth for Bitbucket Server.
  • ad35364e97: feat(techdocs): add edit button support for bitbucketServer

Patch Changes

  • 163243a4d1: Handle incorrect return type from Octokit paginate plugin to resolve reading URLs from GitHub
  • c4b460a47d: Avoid double encoding of the file path in getBitbucketDownloadUrl
  • 29f782eb37: Updated dependency @types/luxon to ^3.0.0.
  • 1f27d83933: Fixed bug in getGitLabFileFetchUrl where a target whose path did not contain the /-/ scope would result in a fetch URL that did not support private-token-based authentication.

1.3.0-next.1

Minor Changes

  • ad35364e97: feat(techdocs): add edit button support for bitbucketServer

Patch Changes

  • 1f27d83933: Fixed bug in getGitLabFileFetchUrl where a target whose path did not contain the /-/ scope would result in a fetch URL that did not support private-token-based authentication.

1.3.0-next.0

Minor Changes

  • 593dea6710: Add support for Basic Auth for Bitbucket Server.

Patch Changes

  • 163243a4d1: Handle incorrect return type from Octokit paginate plugin to resolve reading URLs from GitHub
  • c4b460a47d: Avoid double encoding of the file path in getBitbucketDownloadUrl
  • 29f782eb37: Updated dependency @types/luxon to ^3.0.0.

1.2.2

Patch Changes

  • 9de15a41d7: Upgrade @octokit/rest to 19.0.3

  • a70869e775: Updated dependency msw to ^0.43.0.

  • 4e9a90e307: Updated dependency luxon to ^3.0.0.

  • 8006d0f9bf: Updated dependency msw to ^0.44.0.

  • 1f29047bad: Updated dependency @octokit/auth-app to ^4.0.0.

  • e2d7b76f43: Upgrade git-url-parse to 12.0.0.

    Motivation for upgrade is transitively upgrading parse-url which is vulnerable to several CVEs detected by Snyk.

    • SNYK-JS-PARSEURL-2935944
    • SNYK-JS-PARSEURL-2935947
    • SNYK-JS-PARSEURL-2936249

  • 8829e175f2: Allow frontend visibility for integrations itself.

  • 954a94f52f: Support self-hosted gitlab installations with relative URL.

  • 4df3390795: Avoid double encoding of the file path in getBitbucketServerDownloadUrl

  • Updated dependencies

    • @backstage/errors@1.1.0

1.2.2-next.3

Patch Changes

  • a70869e775: Updated dependency msw to ^0.43.0.
  • 4e9a90e307: Updated dependency luxon to ^3.0.0.
  • 1f29047bad: Updated dependency @octokit/auth-app to ^4.0.0.
  • 4df3390795: Avoid double encoding of the file path in getBitbucketServerDownloadUrl

1.2.2-next.2

Patch Changes

  • e2d7b76f43: Upgrade git-url-parse to 12.0.0.

    Motivation for upgrade is transitively upgrading parse-url which is vulnerable to several CVEs detected by Snyk.

    • SNYK-JS-PARSEURL-2935944
    • SNYK-JS-PARSEURL-2935947
    • SNYK-JS-PARSEURL-2936249

1.2.2-next.1

Patch Changes

  • Updated dependencies
    • @backstage/errors@1.1.0-next.0

1.2.2-next.0

Patch Changes

  • 8829e175f2: Allow frontend visibility for integrations itself.

1.2.1

Patch Changes

  • 72dfcbc8bf: Gerrit Integration: Handle absolute paths in resolveUrl properly.
  • 8f7b1835df: Updated dependency msw to ^0.41.0.
  • e37c71b5a4: Updated to support deployments of Azure DevOps Server under TFS or similar sub path

1.2.1-next.2

Patch Changes

  • e37c71b5a4: Updated to support deployments of Azure DevOps Server under TFS or similar sub path

1.2.1-next.1

Patch Changes

1.2.1-next.0

Patch Changes

  • 72dfcbc8bf: Gerrit Integration: Handle absolute paths in resolveUrl properly.

1.2.0

Minor Changes

  • e295ce87de: added the possibility to handle raw Gitlab URLs with nested namespaces

  • 6673babab9: Gerrit UrlReader: Implemented readTree

  • 1b4e1e2306: Split bitbucket integration into bitbucketCloud and bitbucketServer (backwards compatible).

    In order to migrate to the new integration configs, move your configs from integrations.bitbucket to integrations.bitbucketCloud or integrations.bitbucketServer.

    Migration example:

    Before:

    integrations:
  bitbucket:
    - host: bitbucket.org
      username: bitbucket_user
      appPassword: app-password
    - host: bitbucket-server.company.com
      token: my-token

    After:

    integrations:
  bitbucketCloud:
    - username: bitbucket_user
      appPassword: app-password
  bitbucketServer:
    - host: bitbucket-server.company.com
      token: my-token

  • 566407bf8a: Gerrit Integration: Added the getGerritProjectsApiUrl function

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.1

1.2.0-next.1

Patch Changes

  • Updated dependencies
    • @backstage/config@1.0.1-next.0

1.2.0-next.0

Minor Changes

  • 6673babab9: Gerrit UrlReader: Implemented readTree

  • 1b4e1e2306: Split bitbucket integration into bitbucketCloud and bitbucketServer (backwards compatible).

    In order to migrate to the new integration configs, move your configs from integrations.bitbucket to integrations.bitbucketCloud or integrations.bitbucketServer.

    Migration example:

    Before:

    integrations:
  bitbucket:
    - host: bitbucket.org
      username: bitbucket_user
      appPassword: app-password
    - host: bitbucket-server.company.com
      token: my-token

    After:

    integrations:
  bitbucketCloud:
    - username: bitbucket_user
      appPassword: app-password
  bitbucketServer:
    - host: bitbucket-server.company.com
      token: my-token

  • 566407bf8a: Gerrit Integration: Added the getGerritProjectsApiUrl function

1.1.0

Minor Changes

  • b7436743cb: Gerrit integration: Added an optional configuration to set the Gitiles base url.

Patch Changes

  • 1691c6c5c2: Clarify that config locations that emit User and Group kinds now need to declare so in the catalog.locations.[].rules

  • 3ef123bbf0: Support external ID when assuming roles in S3 integration

    In order to assume a role created by a 3rd party as external ID is needed. This change adds an optional field to the s3 integration configuration and consumes that in the AwsS3UrlReader.

  • d26e1b0146: Exported replaceGitLabUrlType from package

1.1.0-next.2

Patch Changes

  • d26e1b0146: Exported replaceGitLabUrlType from package

1.1.0-next.1

Minor Changes

  • b7436743cb: Gerrit integration: Added an optional configuration to set the Gitiles base url.

Patch Changes

  • 1691c6c5c2: Clarify that config locations that emit User and Group kinds now need to declare so in the catalog.locations.[].rules

1.0.1-next.0

Patch Changes

  • 3ef123bbf0: Support external ID when assuming roles in S3 integration

    In order to assume a role created by a 3rd party as external ID is needed. This change adds an optional field to the s3 integration configuration and consumes that in the AwsS3UrlReader.

1.0.0

Major Changes

  • b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our versioning policy.

Patch Changes

  • 403837cbac: Added an integration for Gerrit
  • Updated dependencies
    • @backstage/config@1.0.0

0.8.0

Minor Changes

  • 34af86517c: ensure apiBaseUrl being set for Bitbucket integrations, replace hardcoded defaults

Patch Changes

  • 33d5e79822: Fix Bitbucket Cloud and Bitbucket Server line number reference.

0.7.5

Patch Changes

  • 4e1384884f: Fixed bug in integration package where Self Hosted GitLab instances with custom ports weren't supported (because of the lack of an option to add the port in the integration configs. Now users can add the port directly in the host)

0.7.4

Patch Changes

  • Fix for the previous release with missing type declarations.
  • Updated dependencies
    • @backstage/config@0.1.15

0.7.3

Patch Changes

  • 1ed305728b: Bump node-fetch to version 2.6.7 and cross-fetch to version 3.1.5
  • c77c5c7eb6: Added backstage.role to package.json
  • Updated dependencies
    • @backstage/config@0.1.14

0.7.2

Patch Changes

  • f45e99e5da: Do not return a token rather than fail where the owner is not in the allowed installation owners for a GitHub app. This allows anonymous access to public files in the organisation.
  • Updated dependencies
    • @backstage/config@0.1.13

0.7.2-next.0

Patch Changes

  • Updated dependencies
    • @backstage/config@0.1.13-next.0

0.7.1

Patch Changes

  • 3b4d8caff6: Adds a new GitHub credentials provider (DefaultGithubCredentialsProvider). It handles multiple app configurations. It looks up the app configuration based on the url.
  • 5333451def: Cleaned up API exports
  • Updated dependencies
    • @backstage/config@0.1.12

0.7.0

Minor Changes

  • 7d4b4e937c: Create an interface for the GitHub credentials provider in order to support providing implementations.

    We have changed the name of the GithubCredentialsProvider to SingleInstanceGithubCredentialsProvider.

    GithubCredentialsProvider is now an interface that maybe implemented to provide a custom mechanism to retrieve GitHub credentials.

    In a later release we will support configuring URL readers, scaffolder tasks, and processors with customer GitHub credentials providers.

    If you want to uptake this release, you will need to replace all references to GithubCredentialsProvider.create with SingleInstanceGithubCredentialsProvider.create.

Patch Changes

  • cf2e20a792: Added endpoint and s3ForcePathStyle as optional configuration for AWS S3 integrations.

0.6.10

Patch Changes

  • 47619da24c: Narrow the types returned by the request option functions, to only the specifics that they actually do return. The reason for this change is that a full RequestInit is unfortunate to return because it's different between cross-fetch and node-fetch.

0.6.9

Patch Changes

  • a15d028517: More API fixes: mark things public, add docs, fix exports
  • Updated dependencies
    • @backstage/config@0.1.11

0.6.8

Patch Changes

  • eab072161e: By replacing \n with a newline for GitHub Apps private keys, this allows users to store the private key as an environment variable and reference it in the YAML.

0.6.7

Patch Changes

  • a31afc5b62: Replace slash stripping regexp with trimEnd to remove CodeQL warning
  • ca0559444c: Avoid usage of .to*Case(), preferring .toLocale*Case('en-US') instead.

0.6.6

Patch Changes

  • d1f2118389: Support selective GitHub app installation for GHE

0.6.5

Patch Changes

  • 8113ba5ebb: Allow file extension .yml to be ingested in GitLab processor
  • Updated dependencies
    • @backstage/config@0.1.10

0.6.4

Patch Changes

  • f7ad3a8925: Fix Azure URL handling to properly support both repo shorthand (/owner/_git/project) and full URLs (/owner/project/_git/repo).

    Fix Azure DevOps Server URL handling by being able to parse URLs with hosts other than dev.azure.com. Note that the api-version used for API requests is currently 6.0, meaning you need to support at least this version in your Azure DevOps Server instance.

  • 96fef17a18: Upgrade git-parse-url to v11.6.0

  • cc5c8f4979: Handle pagination on return results when fetch GitHub API to list selected repos

0.6.3

Patch Changes

  • 5dca42b17: Update to properly handle Azure DevOps Server download URL

0.6.2

Patch Changes

  • f0ba514f0: Take custom ports into account when matching integrations to URLs. It used to be the case that an integration with e.g. host: 'scm.mycompany.net:8080' would not be matched by the byUrl method, while hosts without a custom port did match.
  • 90c68a2ca: Export replaceGitHubUrlType
  • Updated dependencies
    • @backstage/config@0.1.8

0.6.1

Patch Changes

  • b8cb12009: Add AWS S3 URL Reader
  • Updated dependencies
    • @backstage/config@0.1.7

0.6.0

Minor Changes

  • ce1958021: getGitHubFileFetchUrl and getGitHubRequestOptions now require a credentials argument. This is needed to address an issue where the raw route was chosen by the UrlReader when using GitHub Apps based auth.

    Deprecated the getGitHubRequestOptions function, which is no longer used internally.

Patch Changes

  • 8bedb75ae: Update Luxon dependency to 2.x
  • 68af4d556: Adds an allow list of GitHub installations
  • 5fd31c2f4: Remove repo restriction from GitHub credentials provider

0.5.9

Patch Changes

  • 3c50ff562: Fixed bug for comparing Organization name in GithubCredentialsProvider
  • Updated dependencies
    • @backstage/config@0.1.6

0.5.8

Patch Changes

  • 43a4ef644: Do not throw in ScmIntegration byUrl for invalid URLs
  • 6841e0113: fix minor version of git-url-parse as 11.5.x introduced a bug for Bitbucket Server
  • b691a938e: Fix downloads from repositories located at bitbucket.org

0.5.7

Patch Changes

  • 22a60518c: Support ingesting multiple GitHub organizations via a new GithubMultiOrgReaderProcessor.

    This new processor handles namespacing created groups according to the org of the associated GitHub team to prevent potential name clashes between organizations. Be aware that this processor is considered alpha and may not be compatible with future org structures in the catalog.

    NOTE: This processor only fully supports auth via GitHub Apps

    To install this processor, import and add it as follows:

    // Typically in packages/backend/src/plugins/catalog.ts
import { GithubMultiOrgReaderProcessor } from '@backstage/plugin-catalog-backend';
// ...
export default async function createPlugin(env: PluginEnvironment) {
  const builder = new CatalogBuilder(env);
  builder.addProcessor(
    GithubMultiOrgReaderProcessor.fromConfig(env.config, {
      logger: env.logger,
    }),
  );
  // ...
}

    Configure in your app-config.yaml by pointing to your GitHub instance and optionally list which GitHub organizations you wish to import. You can also configure what namespace you want to set for teams from each org. If unspecified, the org name will be used as the namespace. If no organizations are listed, by default this processor will import from all organizations accessible by all configured GitHub Apps:

    catalog:
  locations:
    - type: github-multi-org
      target: https://github.myorg.com
      rules:
        - allow: [User, Group]

  processors:
    githubMultiOrg:
      orgs:
        - name: fooOrg
          groupNamespace: foo
        - name: barOrg
          groupNamespace: bar
        - name: awesomeOrg
        - name: anotherOrg

0.5.6

Patch Changes

  • eda9dbd5f: Download archives as compressed tar files for Bitbucket to keep executable permissions.

0.5.5

Patch Changes

  • 49d7ec169: GitHub App ID can be a string too for environment variables otherwise it will fail validation

0.5.4

Patch Changes

  • 0fd4ea443: Updates the GithubCredentialsProvider to return the token type, it can either be token or app depending on the authentication method.

    Update the GithubOrgReaderProcessor NOT to query for email addresses if GitHub Apps is used for authentication, this is due to inconsistencies in the GitHub API when using server to server communications and installation tokens. See this community discussion for more info.

    Removes deprecated GithubOrgReaderProcessor provider configuration(catalog.processors.githubOrg). If you're using the deprecated config section make sure to migrate to integrations instead.

0.5.3

Patch Changes

0.5.2

Patch Changes

  • 38ca05168: The default @octokit/rest dependency was bumped to "^18.5.3".
  • Updated dependencies [d8b81fd28]
    • @backstage/config@0.1.5

0.5.1

Patch Changes

  • 277644e09: Include missing fields in GitLab config schema. This sometimes prevented loading config on the frontend specifically, when using self-hosted GitLab.
  • 52f613030: Support GitHub tree URLs in getGitHubFileFetchUrl.
  • 905cbfc96: Add resolveEditUrl to integrations to resolve a URL that can be used to edit a file in the web interfaces of an SCM.
  • d4e77ec5f: Add option to resolveUrl that allows for linking to a specific line number when resolving a file URL.

0.5.0

Minor Changes

  • 491f3a0ec: Make ScmIntegration.resolveUrl mandatory.

0.4.0

Minor Changes

  • ffffea8e6: Update the GitLabIntegrationConfig to require the fields apiBaseUrl and baseUrl. The readGitLabIntegrationConfig function is now more strict and has better error reporting. This change mirrors actual reality in code more properly - the fields are actually necessary for many parts of code to actually function, so they should no longer be optional.

    Some checks that used to happen deep inside code that consumed config, now happen upfront at startup. This means that you may encounter new errors at backend startup, if you had actual mistakes in config but didn't happen to exercise the code paths that actually would break. But for most users, no change will be necessary.

    An example minimal GitLab config block that just adds a token to public GitLab would look similar to this:

    integrations:
  gitlab:
    - host: gitlab.com
      token:
        $env: GITLAB_TOKEN

    A full fledged config that points to a locally hosted GitLab could look like this:

    integrations:
  gitlab:
    - host: gitlab.my-company.com
      apiBaseUrl: https://gitlab.my-company.com/api/v4
      baseUrl: https://gitlab.my-company.com
      token:
        $env: OUR_GITLAB_TOKEN

    In this case, the only optional field is baseUrl which is formed from the host if needed.

0.3.2

Patch Changes

  • c4abcdb60: Fix GitLab handling of paths with spaces

  • 064c513e1: Properly forward errors that occur when looking up GitLab project IDs.

  • 3149bfe63: Add a resolveUrl method to integrations, that works like the two-argument URL constructor. The reason for using this is that Azure have their paths in a query parameter, rather than the pathname of the URL.

    The implementation is optional (when not present, the URL constructor is used), so this does not imply a breaking change.

  • 2e62aea6f: #4322 Bitbucket own hosted v5.11.1 branchUrl fix and enabled error tracing… #4347

0.3.1

Patch Changes

0.3.0

Minor Changes

  • ed6baab66: - Deprecating the scaffolder.${provider}.token auth duplication and favoring integrations.${provider} instead. If you receive deprecation warnings your config should change like the following:

    scaffolder:
  github:
    token:
      $env: GITHUB_TOKEN
    visibility: public

    To something that looks like this:

    integration:
  github:
    - host: github.com
      token:
        $env: GITHUB_TOKEN
scaffolder:
  github:
    visibility: public

    You can also configure multiple different hosts under the integration config like the following:

    integration:
  github:
    - host: github.com
      token:
        $env: GITHUB_TOKEN
    - host: ghe.mycompany.com
      token:
        $env: GITHUB_ENTERPRISE_TOKEN

    This of course is the case for all the providers respectively.

    • Adding support for cross provider scaffolding, you can now create repositories in for example Bitbucket using a template residing in GitHub.

    • Fix GitLab scaffolding so that it returns a catalogInfoUrl which automatically imports the project into the catalog.

    • The Store Path field on the scaffolder frontend has now changed so that you require the full URL to the desired destination repository.

    backstage/new-repository would become https://github.com/backstage/new-repository if provider was GitHub for example.

Patch Changes

  • 0b135e7e0: Add support for GitHub Apps authentication for backend plugins.

    GithubCredentialsProvider requests and caches GitHub credentials based on a repository or organization url.

    The GithubCredentialsProvider class should be considered stateful since tokens will be cached internally. Consecutive calls to get credentials will return the same token, tokens older than 50 minutes will be considered expired and reissued. GithubCredentialsProvider will default to the configured access token if no GitHub Apps are configured.

    More information on how to create and configure a GitHub App to use with backstage can be found in the documentation.

    Usage:

    const credentialsProvider = new GithubCredentialsProvider(config);
const { token, headers } = await credentialsProvider.getCredentials({
  url: 'https://github.com/',
});

    Updates GithubUrlReader to use the GithubCredentialsProvider.

  • fa8ba330a: Fix GitLab API base URL and add it by default to the gitlab.com host

0.2.0

Minor Changes

  • 466354aaa: Build out the ScmIntegrations class, as well as the individual *Integration classes

0.1.5

Patch Changes

  • 036a84373: Provide support for on-prem azure devops

0.1.4

Patch Changes

  • 1d1c2860f: Implement readTree on BitBucketUrlReader and getBitbucketDownloadUrl
  • 4eafdec4a: Introduce readTree method for GitLab URL Reader
  • 178e09323: Validate that integration config contains a valid host

0.1.3

Patch Changes

  • 38e24db00: Move the core url and auth logic to integration for the four major providers
  • b8ecf6f48: Add the basics of cross-integration concerns
  • Updated dependencies [e3bd9fc2f]
  • Updated dependencies [e3bd9fc2f]
    • @backstage/config@0.1.2

0.1.2

Patch Changes

  • b3d4e4e57: Move the frontend visibility declarations of integrations config from @backstage/backend-common to @backstage/integration

0.1.1

Patch Changes

Reference in New Issue View Git Blame Copy Permalink