paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 39 Packages Projects Releases Wiki Activity
Files
30882884a4fe96c78b8ebfc0b7163ad5a1306ba4
backstage/packages/integration/CHANGELOG.md
T
github-actions[bot] 30882884a4 Version Packages
2022-09-20 11:52:02 +00:00

24 KiB
Raw Blame History

@backstage/integration

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