Version Packages

2021-01-21 13:13:05 +00:00
parent bf2dda31bb
commit c5584b62c2
141 changed files with 1584 additions and 799 deletions
@@ -1,5 +1,79 @@
 # @backstage/backend-common

+## 0.5.0
+
+### Minor Changes
+
+- 5345a1f98: Remove fallback option from `UrlReaders.create` and `UrlReaders.default`, as well as the default fallback reader.
+
+  To be able to read data from endpoints outside of the configured integrations, you now need to explicitly allow it by
+  adding an entry in the `backend.reading.allow` list. For example:
+
+  ```yml
+  backend:
+    baseUrl: ...
+    reading:
+      allow:
+        - host: example.com
+        - host: '*.examples.org'
+  ```
+
+  Apart from adding the above configuration, most projects should not need to take any action to migrate existing code. If you do happen to have your own fallback reader configured, this needs to be replaced with a reader factory that selects a specific set of URLs to work with. If you where wrapping the existing fallback reader, the new one that handles the allow list is created using `FetchUrlReader.factory`.
+
+- 09a370426: Remove support for HTTPS certificate generation parameters. Use `backend.https = true` instead.
+
+### 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:
+
+  ```javascript
+  const credentialsProvider = new GithubCredentialsProvider(config);
+  const { token, headers } = await credentialsProvider.getCredentials({
+    url: 'https://github.com/',
+  });
+  ```
+
+  Updates `GithubUrlReader` to use the `GithubCredentialsProvider`.
+
+- 294a70cab: 1. URL Reader's `readTree` method now returns an `etag` in the response along with the blob. The etag is an identifier of the blob and will only change if the blob is modified on the target. Usually it is set to the latest commit SHA on the target.
+
+  `readTree` also takes an optional `etag` in its options and throws a `NotModifiedError` if the etag matches with the etag of the resource.
+
+  So, the `etag` can be used in building a cache when working with URL Reader.
+
+  An example -
+
+  ```ts
+  const response = await reader.readTree(
+    'https://github.com/backstage/backstage',
+  );
+
+  const etag = response.etag;
+
+  // Will throw a new NotModifiedError (exported from @backstage/backstage-common)
+  await reader.readTree('https://github.com/backstage/backstage', {
+    etag,
+  });
+  ```
+
+  2. URL Reader's readTree method can now detect the default branch. So, `url:https://github.com/org/repo/tree/master` can be replaced with `url:https://github.com/org/repo` in places like `backstage.io/techdocs-ref`.
+
+- 0ea032763: URL Reader: Use API response headers for archive filename in readTree. Fixes bug for users with hosted Bitbucket.
+- Updated dependencies [0b135e7e0]
+- Updated dependencies [fa8ba330a]
+- Updated dependencies [ed6baab66]
+  - @backstage/integration@0.3.0
+
 ## 0.4.3

 ### Patch Changes