@backstage/plugin-devtools 0.1.1-next.1 → 0.1.1-next.3

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 (3) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +26 -0
  3. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # @backstage/plugin-devtools
2
2
 
3
+ ## 0.1.1-next.3
4
+
5
+ ### Patch Changes
6
+
7
+ - 62d191f6c8b5: Updated DevTools documentation for Docker users
8
+ - Updated dependencies
9
+ - @backstage/core-components@0.13.2-next.3
10
+ - @backstage/core-plugin-api@1.5.2-next.0
11
+ - @backstage/errors@1.2.0-next.0
12
+ - @backstage/theme@0.4.0-next.1
13
+ - @backstage/types@1.0.2
14
+ - @backstage/plugin-devtools-common@0.1.1-next.0
15
+ - @backstage/plugin-permission-react@0.4.13-next.0
16
+
17
+ ## 0.1.1-next.2
18
+
19
+ ### Patch Changes
20
+
21
+ - Updated dependencies
22
+ - @backstage/theme@0.4.0-next.1
23
+ - @backstage/core-components@0.13.2-next.2
24
+ - @backstage/core-plugin-api@1.5.2-next.0
25
+ - @backstage/plugin-permission-react@0.4.13-next.0
26
+
3
27
  ## 0.1.1-next.1
4
28
 
5
29
  ### Patch Changes
package/README.md CHANGED
@@ -12,6 +12,20 @@ Lists helpful information about your current running Backstage instance such as:
12
12
 
13
13
  ![Example of Info tab](./docs/devtools-info-tab.png)
14
14
 
15
+ #### Backstage Version Reporting
16
+
17
+ The Backstage Version that is reported requires `backstage.json` to be present at the root of the running backstage instance.
18
+ You may need to modify your Dockerfile to ensure `backstage.json` is copied into the `WORKDIR` of your image.
19
+
20
+ ```sh
21
+ WORKDIR /app
22
+ # This switches many Node.js dependencies to production mode.
23
+ ENV NODE_ENV production
24
+
25
+ # Then copy the rest of the backend bundle, along with any other files we might want (including backstage.json).
26
+ COPY --chown=node:node ... backstage.json ./
27
+ ```
28
+
15
29
  ### Config
16
30
 
17
31
  Lists the configuration being used by your current running Backstage instance.
@@ -375,3 +389,15 @@ Configuration details:
375
389
  - `name` is the friendly name for your endpoint
376
390
  - `type` can be either `ping` or `fetch` and will perform the respective action on the `target`
377
391
  - `target` is either a URL or server that you want to trigger a `type` action on
392
+
393
+ ### External Dependencies Requirements
394
+
395
+ If you are using the `ping` type you must ensure that `ping` is available in the Host OS that is running Backstage.
396
+ For example you may need to add `ping` into the Dockerfile that builds your Backstage image:
397
+
398
+ ```sh
399
+ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
400
+ --mount=type=cache,target=/var/lib/apt,sharing=locked \
401
+ apt-get update && \
402
+ apt-get install -y ... iputils-ping
403
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-devtools",
3
- "version": "0.1.1-next.1",
3
+ "version": "0.1.1-next.3",
4
4
  "main": "dist/index.esm.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "license": "Apache-2.0",
@@ -28,12 +28,12 @@
28
28
  "postpack": "backstage-cli package postpack"
29
29
  },
30
30
  "dependencies": {
31
- "@backstage/core-components": "^0.13.2-next.1",
31
+ "@backstage/core-components": "^0.13.2-next.3",
32
32
  "@backstage/core-plugin-api": "^1.5.2-next.0",
33
33
  "@backstage/errors": "^1.2.0-next.0",
34
34
  "@backstage/plugin-devtools-common": "^0.1.1-next.0",
35
35
  "@backstage/plugin-permission-react": "^0.4.13-next.0",
36
- "@backstage/theme": "^0.4.0-next.0",
36
+ "@backstage/theme": "^0.4.0-next.1",
37
37
  "@backstage/types": "^1.0.2",
38
38
  "@material-ui/core": "^4.9.13",
39
39
  "@material-ui/icons": "^4.9.1",
@@ -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.22.8-next.1",
50
+ "@backstage/cli": "^0.22.8-next.2",
51
51
  "@backstage/core-app-api": "^1.8.1-next.0",
52
- "@backstage/dev-utils": "^1.0.16-next.1",
53
- "@backstage/test-utils": "^1.4.0-next.1",
52
+ "@backstage/dev-utils": "^1.0.16-next.3",
53
+ "@backstage/test-utils": "^1.4.0-next.2",
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",