@spotify/backstage-plugin-soundcheck-backend-module-github 0.6.3 → 0.6.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +44 -0
  2. package/config.d.ts +2 -0
  3. package/dist/index.d.ts +4 -1
  4. package/package.json +21 -14
package/CHANGELOG.md CHANGED
@@ -1,5 +1,49 @@
1
1
  # @spotify/backstage-plugin-soundcheck-backend-module-github
2
2
 
3
+ ## 0.6.5
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @spotify/backstage-plugin-soundcheck-common@0.14.4
9
+ - @spotify/backstage-plugin-soundcheck-node@0.8.5
10
+
11
+ ## 0.6.4
12
+
13
+ ### Patch Changes
14
+
15
+ - Update to Backstage `v1.33.3`
16
+ - Updated dependency `git-url-parse` to `^16.0.0`.
17
+ - Added exclusion filters to check and fact collector scheduling.
18
+
19
+ Example for fact collectors:
20
+
21
+ ```yaml
22
+ collects:
23
+ - factName: branch_protections
24
+ type: BranchProtections
25
+ branch: master
26
+ exclude:
27
+ - spec.lifecycle: 'experimental'
28
+ ```
29
+
30
+ This would exclude all entities what have lifecycle experimental from the collection.
31
+
32
+ - Support for Backstage's Legacy Backend System is deprecated and will be removed in January. Please be sure to have migrated your Backstage backend to the New Backend System by then, leveraging the `default` export from this module instead.
33
+ - Added the ability to override the entities batch size for collections by providing a `batchSize` within a `CollectionConfig`.
34
+ By default, a collection will be scheduled for a single entity but this behavior may now be overridden by providing a `batchSize`.
35
+
36
+ NOTE: Collection Rate Limiting enabled by the `soundcheck.job.workers.<collector_id>.limiter` configuration will count collecting
37
+ facts for a batch of entities as a single hit to the rate limit, while the actual number of hits is usually equal to the batch size.
38
+ Enable batching for the exiting collectors at your own discretion.
39
+
40
+ - Updated dependencies
41
+ - Updated dependencies
42
+ - Updated dependencies
43
+ - Updated dependencies
44
+ - @spotify/backstage-plugin-soundcheck-common@0.14.3
45
+ - @spotify/backstage-plugin-soundcheck-node@0.8.4
46
+
3
47
  ## 0.6.3
4
48
 
5
49
  ### Patch Changes
package/config.d.ts CHANGED
@@ -29,7 +29,9 @@ export interface Config {
29
29
  }
30
30
  | HumanDuration;
31
31
  initialDelay?: Duration | HumanDuration;
32
+ batchSize?: number;
32
33
  filter?: EntityFilter;
34
+ exclude?: EntityFilter;
33
35
  cache?:
34
36
  | {
35
37
  duration: Duration | HumanDuration;
package/dist/index.d.ts CHANGED
@@ -11,6 +11,9 @@ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
11
11
  * Soundcheck 3rd party integration - Github.
12
12
  *
13
13
  * @public
14
+ * @deprecated This will be removed in an upcoming release. Use the default
15
+ * export from this package in combination with the "New" Backstage Backend
16
+ * system instead.
14
17
  */
15
18
  declare class GithubFactCollector implements ConfigurableFactCollector {
16
19
  #private;
@@ -40,7 +43,7 @@ declare class GithubFactCollector implements ConfigurableFactCollector {
40
43
  getConfigSchema(): Promise<string>;
41
44
  }
42
45
 
43
- /** @alpha */
46
+ /** @public */
44
47
  declare const githubSoundcheckModule: _backstage_backend_plugin_api.BackendFeature;
45
48
 
46
49
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@spotify/backstage-plugin-soundcheck-backend-module-github",
3
3
  "description": "Soundcheck 3rd party integration with Github",
4
- "version": "0.6.3",
4
+ "version": "0.6.5",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "homepage": "https://backstage.spotify.com",
7
7
  "main": "dist/index.cjs.js",
@@ -24,26 +24,26 @@
24
24
  "postpack": "backstage-cli package postpack"
25
25
  },
26
26
  "devDependencies": {
27
- "@backstage/backend-test-utils": "^1.0.1",
28
- "@backstage/cli": "^0.28.0",
29
- "@spotify/backstage-plugin-soundcheck-backend": "^0.17.6",
27
+ "@backstage/backend-test-utils": "^1.1.0",
28
+ "@backstage/cli": "^0.29.2",
29
+ "@spotify/backstage-plugin-soundcheck-backend": "^0.17.8",
30
30
  "@types/git-url-parse": "^9.0.0",
31
31
  "@types/luxon": "^3.0.1",
32
32
  "supertest": "^7.0.0"
33
33
  },
34
34
  "dependencies": {
35
35
  "@backstage/backend-common": "^0.25.0",
36
- "@backstage/backend-plugin-api": "^1.0.1",
37
- "@backstage/catalog-model": "^1.7.0",
38
- "@backstage/config": "^1.2.0",
39
- "@backstage/errors": "^1.2.4",
40
- "@backstage/integration": "^1.15.1",
41
- "@backstage/types": "^1.1.1",
36
+ "@backstage/backend-plugin-api": "^1.0.2",
37
+ "@backstage/catalog-model": "^1.7.1",
38
+ "@backstage/config": "^1.3.0",
39
+ "@backstage/errors": "^1.2.5",
40
+ "@backstage/integration": "^1.15.2",
41
+ "@backstage/types": "^1.2.0",
42
42
  "@octokit/request-error": "^5.0.0",
43
43
  "@octokit/rest": "^20.0.0",
44
- "@spotify/backstage-plugin-soundcheck-common": "^0.14.2",
45
- "@spotify/backstage-plugin-soundcheck-node": "^0.8.3",
46
- "git-url-parse": "^15.0.0",
44
+ "@spotify/backstage-plugin-soundcheck-common": "^0.14.4",
45
+ "@spotify/backstage-plugin-soundcheck-node": "^0.8.5",
46
+ "git-url-parse": "^16.0.0",
47
47
  "lodash": "^4.17.21",
48
48
  "luxon": "^3.1.1",
49
49
  "winston": "^3.2.1",
@@ -55,5 +55,12 @@
55
55
  "!dist/**/*.map",
56
56
  "config.d.ts"
57
57
  ],
58
- "configSchema": "config.d.ts"
58
+ "configSchema": "config.d.ts",
59
+ "typesVersions": {
60
+ "*": {
61
+ "index": [
62
+ "dist/index.d.ts"
63
+ ]
64
+ }
65
+ }
59
66
  }