@backstage/plugin-devtools 0.0.0-nightly-20230627023436 → 0.0.0-nightly-20230629023239
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.
- package/CHANGELOG.md +21 -5
- package/README.md +43 -0
- package/package.json +8 -8
package/CHANGELOG.md
CHANGED
|
@@ -1,18 +1,34 @@
|
|
|
1
1
|
# @backstage/plugin-devtools
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20230629023239
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
7
|
- 5969639fd075: Allow specifying custom title for `DevToolsLayout`
|
|
8
|
+
- 2c4869473155: Updated the `README` with instructions on how to integrate the Catalog Unprocessed Entities plugin as a tab within DevTools
|
|
8
9
|
- Updated dependencies
|
|
9
|
-
- @backstage/errors@0.0.0-nightly-
|
|
10
|
-
- @backstage/core-components@0.0.0-nightly-
|
|
10
|
+
- @backstage/errors@0.0.0-nightly-20230629023239
|
|
11
|
+
- @backstage/core-components@0.0.0-nightly-20230629023239
|
|
11
12
|
- @backstage/core-plugin-api@1.5.2
|
|
12
13
|
- @backstage/theme@0.4.0
|
|
13
14
|
- @backstage/types@1.1.0
|
|
14
|
-
- @backstage/plugin-devtools-common@0.0.0-nightly-
|
|
15
|
-
- @backstage/plugin-permission-react@0.0.0-nightly-
|
|
15
|
+
- @backstage/plugin-devtools-common@0.0.0-nightly-20230629023239
|
|
16
|
+
- @backstage/plugin-permission-react@0.0.0-nightly-20230629023239
|
|
17
|
+
|
|
18
|
+
## 0.1.2-next.0
|
|
19
|
+
|
|
20
|
+
### Patch Changes
|
|
21
|
+
|
|
22
|
+
- 5969639fd075: Allow specifying custom title for `DevToolsLayout`
|
|
23
|
+
- 2c4869473155: Updated the `README` with instructions on how to integrate the Catalog Unprocessed Entities plugin as a tab within DevTools
|
|
24
|
+
- Updated dependencies
|
|
25
|
+
- @backstage/errors@1.2.1-next.0
|
|
26
|
+
- @backstage/core-components@0.13.3-next.0
|
|
27
|
+
- @backstage/core-plugin-api@1.5.2
|
|
28
|
+
- @backstage/theme@0.4.0
|
|
29
|
+
- @backstage/types@1.1.0
|
|
30
|
+
- @backstage/plugin-devtools-common@0.1.2-next.0
|
|
31
|
+
- @backstage/plugin-permission-react@0.4.14-next.0
|
|
16
32
|
|
|
17
33
|
## 0.1.1
|
|
18
34
|
|
package/README.md
CHANGED
|
@@ -44,6 +44,12 @@ Lists the status of configured External Dependencies based on your current runni
|
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
|
|
47
|
+
### Catalog Unprocessed Entities
|
|
48
|
+
|
|
49
|
+
The [Catalog Unprocessed Entities plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog-unprocessed-entities) has an optional tab that you can also be added that will show unprocessed entities:
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
47
53
|
## Setup
|
|
48
54
|
|
|
49
55
|
The following sections will help you get the DevTools plugin setup and running.
|
|
@@ -149,6 +155,43 @@ The DevTools plugin has been designed so that you can customize the tabs to suit
|
|
|
149
155
|
|
|
150
156
|
With this setup you can add or remove the tabs as you'd like or add your own simply by editing your `CustomDevToolsPage.tsx` file
|
|
151
157
|
|
|
158
|
+
### Adding Tabs From Other Plugins
|
|
159
|
+
|
|
160
|
+
You can also add tabs to show content from other plugins that fit well with the other DevTools content.
|
|
161
|
+
|
|
162
|
+
#### Catalog Unprocessed Entities Tab
|
|
163
|
+
|
|
164
|
+
Here's how to add the Catalog Unprocessed Entities tab:
|
|
165
|
+
|
|
166
|
+
1. Install and setup the [Catalog Unprocessed Entities plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog-unprocessed-entities) as per its documentation
|
|
167
|
+
2. Add the following import to your `CustomDevToolsPage.tsx`:
|
|
168
|
+
|
|
169
|
+
`import { UnprocessedEntitiesContent } from '@backstage/plugin-catalog-unprocessed-entities';`
|
|
170
|
+
|
|
171
|
+
3. Then add a new `DevToolsLayout.Route` to the end of your `DevToolsLayout` like this:
|
|
172
|
+
|
|
173
|
+
```diff
|
|
174
|
+
<DevToolsLayout>
|
|
175
|
+
<DevToolsLayout.Route path="info" title="Info">
|
|
176
|
+
<InfoContent />
|
|
177
|
+
</DevToolsLayout.Route>
|
|
178
|
+
<DevToolsLayout.Route path="config" title="Config">
|
|
179
|
+
<ConfigContent />
|
|
180
|
+
</DevToolsLayout.Route>
|
|
181
|
+
<DevToolsLayout.Route
|
|
182
|
+
path="external-dependencies"
|
|
183
|
+
title="External Dependencies"
|
|
184
|
+
>
|
|
185
|
+
<ExternalDependenciesContent />
|
|
186
|
+
</DevToolsLayout.Route>
|
|
187
|
+
+ <DevToolsLayout.Route path="unprocessed-entities" title="Unprocessed Entities">
|
|
188
|
+
+ <UnprocessedEntitiesContent />
|
|
189
|
+
+ </DevToolsLayout.Route>
|
|
190
|
+
</DevToolsLayout>
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
4. Now run `yarn dev` and navigate to the DevTools you'll see a new tab for Unprocessed Entities
|
|
194
|
+
|
|
152
195
|
## Permissions
|
|
153
196
|
|
|
154
197
|
The DevTools plugin supports the [permissions framework](https://backstage.io/docs/permissions/overview), the following sections outline how you can use them with the assumption that you have the permissions framework setup and working.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-devtools",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20230629023239",
|
|
4
4
|
"main": "dist/index.esm.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -28,11 +28,11 @@
|
|
|
28
28
|
"postpack": "backstage-cli package postpack"
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@backstage/core-components": "^0.0.0-nightly-
|
|
31
|
+
"@backstage/core-components": "^0.0.0-nightly-20230629023239",
|
|
32
32
|
"@backstage/core-plugin-api": "^1.5.2",
|
|
33
|
-
"@backstage/errors": "^0.0.0-nightly-
|
|
34
|
-
"@backstage/plugin-devtools-common": "^0.0.0-nightly-
|
|
35
|
-
"@backstage/plugin-permission-react": "^0.0.0-nightly-
|
|
33
|
+
"@backstage/errors": "^0.0.0-nightly-20230629023239",
|
|
34
|
+
"@backstage/plugin-devtools-common": "^0.0.0-nightly-20230629023239",
|
|
35
|
+
"@backstage/plugin-permission-react": "^0.0.0-nightly-20230629023239",
|
|
36
36
|
"@backstage/theme": "^0.4.0",
|
|
37
37
|
"@backstage/types": "^1.1.0",
|
|
38
38
|
"@material-ui/core": "^4.9.13",
|
|
@@ -47,10 +47,10 @@
|
|
|
47
47
|
"react-router-dom": "6.0.0-beta.0 || ^6.3.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
|
-
"@backstage/cli": "^0.0.0-nightly-
|
|
50
|
+
"@backstage/cli": "^0.0.0-nightly-20230629023239",
|
|
51
51
|
"@backstage/core-app-api": "^1.8.1",
|
|
52
|
-
"@backstage/dev-utils": "^0.0.0-nightly-
|
|
53
|
-
"@backstage/test-utils": "^0.0.0-nightly-
|
|
52
|
+
"@backstage/dev-utils": "^0.0.0-nightly-20230629023239",
|
|
53
|
+
"@backstage/test-utils": "^0.0.0-nightly-20230629023239",
|
|
54
54
|
"@testing-library/jest-dom": "^5.10.1",
|
|
55
55
|
"@testing-library/react": "^12.1.3",
|
|
56
56
|
"@testing-library/user-event": "^14.0.0",
|