Merge remote-tracking branch 'origin/master' into blam/break-up-scaffolder

* origin/master: (55 commits)
  backend-app-api: switch plugin log label pluginId->plugin
  backend-app-api: create a labelled logger for rootHttpRouter
  backend-app-api: remove startHttpServer
  fix(deps): update dependency @rjsf/utils to v5.0.0-beta.16
  backend-app-api: fix infinite loop in http server stop
  remove autoformatting changes
  remove dev file
  use index for key in react fragment
  Minor grammar fix to CONTRIBUTING.md
  backend-app-api: explicit request handler types for MiddlewareFactory
  added changesets for the root API refactor and move from backend-common
  backend-app-api: update API report + fixes
  add highlighting of legend item
  docs(docs/features/software-templates/writing-custom-field-extensions.md): change "kehab" to "kebab".
  backend-app-api: move http dir out of lib
  backend-common: reimplement service builder using backend-app-api
  backend-app-api: move cors and helmet options reader to http folder
  address review comments
  fix picky cli-report
  fix logic
  ...

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2023-01-10 14:19:53 +01:00
89 changed files with 2360 additions and 1013 deletions
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/backend-defaults': patch
'@backstage/backend-app-api': patch
---
Use new `ServiceFactoryOrFunction` type.
+5
View File
@@ -0,0 +1,5 @@
---
'@techdocs/cli': minor
---
Add `--preview-app-bundle-path` and `--preview-app-port` options to the `serve` command enabling previewing with apps other than the provided one
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-plugin-api': patch
---
Added `ServiceFactoryOrFunction` type, for use when either a `ServiceFactory` or `() => ServiceFactory` can be used.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-app-api': patch
---
Moved over implementation of the root HTTP service from `@backstage/backend-common`, and replaced the `middleware` option with a `configure` callback option.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-tasks': patch
---
Minor internal refactor to avoid import cycle issue.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-tech-radar': minor
---
Add highlighting of legend item and show bubble on hover within the Tech Radar
+69
View File
@@ -0,0 +1,69 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
This patch adds changes to provide examples alongside scaffolder task actions.
The `createTemplateAction` function now takes a list of examples e.g.
```typescript
const actionExamples = [
{
description: 'Example 1',
example: yaml.stringify({
steps: [
{
action: 'test:action',
id: 'test',
input: {
input1: 'value',
},
},
],
}),
},
];
export function createTestAction() {
return createTemplateAction({
id: 'test:action',
examples: [
{
description: 'Example 1',
examples: actionExamples
}
],
...,
});
```
These examples can be retrieved later from the api.
```bash
curl http://localhost:7007/api/scaffolder/v2/actions
```
```json
[
{
"id": "test:action",
"examples": [
{
"description": "Example 1",
"example": "steps:\n - action: test:action\n id: test\n input:\n input1: value\n"
}
],
"schema": {
"input": {
"type": "object",
"properties": {
"input1": {
"title": "Input 1",
"type": "string"
}
}
}
}
}
]
```
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-common': patch
---
Refactor to rely on `@backstage/backend-app-api` for the implementation of `createServiceBuilder`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-app-api': patch
---
Tweaked the plugin logger to use `plugin` as the label for the plugin ID, rather than `pluginId`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder': patch
---
Show action example yaml on the scaffolder actions documentation page.
+16
View File
@@ -0,0 +1,16 @@
---
'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch
'@backstage/plugin-catalog-backend-module-bitbucket-server': patch
'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch
'@backstage/plugin-catalog-backend-module-msgraph': patch
'@backstage/plugin-catalog-backend-module-gerrit': patch
'@backstage/plugin-catalog-backend-module-github': patch
'@backstage/plugin-catalog-backend-module-gitlab': patch
'@backstage/plugin-events-backend-module-aws-sqs': patch
'@backstage/plugin-catalog-backend-module-azure': patch
'@backstage/plugin-catalog-backend-module-ldap': patch
'@backstage/plugin-catalog-backend-module-aws': patch
'@techdocs/cli': patch
---
Provide context for logged errors.