You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: workspaces/orchestrator/plugins/orchestrator-form-widgets/README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -69,13 +69,13 @@ Example of response:
69
69
}
70
70
```
71
71
72
-
## HTTP Test Server
72
+
## HTTP server for dynamic widgets development - http-workflow-dev-server
73
73
74
-
**For the development purposes only**, there is `http-test-server`, very simple Express Node.js server which responds with JSON schema chunks for the `SchemaUpdater` and other active widgets.
74
+
**For the development purposes only**, there is `http-workflow-dev-server`, very simple Express Node.js server which responds with JSON schema chunks for the `SchemaUpdater` and other active widgets.
75
75
76
76
Moreover, it does extensive logging of the received HTTP requests for debugging during the widget's development.
77
77
78
-
Refer to [http-test-server](./http-test-server/README.md) for more details.
78
+
Refer to [http-workflow-dev-server](./http-workflow-dev-server/README.md) for more details.
79
79
80
80
## How to develop widgets
81
81
@@ -86,7 +86,7 @@ This instance is already configured to statically load the widget library (see `
86
86
87
87
To develop the widgets, we recommend to uncomment or further configure the `integrations:` and `auth:` sections in the `./workspaces/orchestrator/app-config.yaml` to be able to test various SCM Auth providers within `$${{}}` templates.
88
88
89
-
Please note, that the `proxy:` section is already pre-configured to match the `http-test-server` listening on localhost.
89
+
Please note, that the `proxy:` section is already pre-configured to match the `http-workflow-dev-server` listening on localhost.
90
90
91
91
Make sure your user has an entity in the Catalog and the authentication is otherwise configured so the tokens and user's profile info can be fetched by the workflow and `$${{identityApi.[various_keys]}}` templating.
92
92
@@ -98,7 +98,7 @@ yarn install
98
98
```
99
99
100
100
```bash
101
-
cd ./workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server
101
+
cd ./workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server
102
102
yarn update-running-workflow # which will copy the workflow under Backstage backend cache
103
103
```
104
104
@@ -134,21 +134,21 @@ yarn start
134
134
- In third terminal, run the HTTP test server:
135
135
136
136
```bash
137
-
cd ./workspaces/orchestrator/plugins/orchestrator-form-widgets/http-test-server
137
+
cd ./workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server
138
138
139
139
yarn install
140
140
yarn start
141
141
```
142
142
143
143
### The dynamic_schema workflow
144
144
145
-
There is `dynamic_schema` workflow located under `http-test-server/exampleWorkflows`.
145
+
There is `dynamic_schema` workflow located under `http-workflow-dev-server/exampleWorkflows`.
146
146
Its purpose is to have a playground when developing the widgets.
147
147
148
-
The URLs referenced from this workflow's data input schema rely on proxy configured in the `./workspaces/orchestrator/app-config.yaml` which assumes the `http-test-server` to be running.
148
+
The URLs referenced from this workflow's data input schema rely on proxy configured in the `./workspaces/orchestrator/app-config.yaml` which assumes the `http-workflow-dev-server` to be running.
149
149
150
150
This dev-only workflow is similar to https://github.com/rhdhorchestrator/backstage-orchestrator-workflows/blob/main/workflows/dynamic.schema.sw.json .
151
-
The difference is in the URLs used - the backstage-orchestrator-workflows' one references public GitHub HTTP server, so no extra steps in running the `http-test-server` are needed.
151
+
The difference is in the URLs used - the backstage-orchestrator-workflows' one references public GitHub HTTP server, so no extra steps in running the `http-workflow-dev-server` are needed.
152
152
153
153
## Development of a workflow using orchestrator-form-widgets
0 commit comments