Merge branch 'patternfly:main' into main

Author: nicolethoen

.eslintrc.json

@@ -9,6 +9,7 @@
     "plugin:react/recommended",
     "plugin:react-hooks/recommended",
     "plugin:@typescript-eslint/recommended",
+    "plugin:react/jsx-runtime",
     "prettier"
   ],
   "overrides": [
@@ -31,13 +32,7 @@
       "version": "detect"
     }
   },
-  "plugins": [
-    "react",
-    "react-hooks",
-    "@typescript-eslint",
-    "patternfly-react",
-    "prettier"
-  ],
+  "plugins": ["react", "react-hooks", "@typescript-eslint", "patternfly-react", "prettier"],
   "rules": {
     "@typescript-eslint/adjacent-overload-signatures": "error",
     "@typescript-eslint/array-type": "error",

.github/workflows/build-lint-test.yml

@@ -14,10 +14,11 @@ jobs:
             git fetch origin pull/$GH_PR_NUM/head:tmp
             git checkout tmp
           fi
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - run: yarn install --frozen-lockfile
+          node-version: '20'
+      - run: corepack enable
+      - run: yarn install --immutable
       - name: generate
         run: cd packages/module && yarn generate
       - name: Build dist
@@ -35,10 +36,11 @@ jobs:
             git fetch origin pull/$GH_PR_NUM/head:tmp
             git checkout tmp
           fi
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - run: yarn install --frozen-lockfile
+          node-version: '20'
+      - run: corepack enable
+      - run: yarn install --immutable
       - name: ESLint
         run: yarn lint:js
       - name: MDLint
@@ -57,10 +59,11 @@ jobs:
             git fetch origin pull/$GH_PR_NUM/head:tmp
             git checkout tmp
           fi
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - run: yarn install --frozen-lockfile
+          node-version: '20'
+      - run: corepack enable
+      - run: yarn install --immutable
       - name: generate
         run: cd packages/module && yarn generate
       - name: Build dist
@@ -81,10 +84,11 @@ jobs:
             git fetch origin pull/$GH_PR_NUM/head:tmp
             git checkout tmp
           fi
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - run: yarn install --frozen-lockfile
+          node-version: '20'
+      - run: corepack enable
+      - run: yarn install --immutable
       - name: generate
         run: cd packages/module && yarn generate
       - name: Build dist

.github/workflows/build.yml

@@ -17,9 +17,10 @@ jobs:
       - name: Run build script
         run: ./devSetup.sh
         shell: bash
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - run: yarn install --frozen-lockfile
+          node-version: '20'
+      - run: corepack enable
+      - run: yarn install --immutable
       - name: Build dist
         run: yarn build

.github/workflows/pr-preview.yml

@@ -7,7 +7,7 @@ jobs:
       SURGE_LOGIN: ${{ secrets.SURGE_LOGIN }}
       SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
       GH_PR_TOKEN: ${{ secrets.GH_PR_TOKEN }}
-      GH_PR_NUM:   ${{ github.event.number }}
+      GH_PR_NUM: ${{ github.event.number }}
     steps:
       - uses: actions/checkout@v2
       # Yes, we really want to checkout the PR
@@ -21,10 +21,11 @@ jobs:
           git log origin/main..HEAD --format="%b"
       # Yes, we really want to checkout the PR
       # Injected by generate-workflows.js
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - run: yarn install --frozen-lockfile
+          node-version: '20'
+      - run: corepack enable
+      - run: yarn install --immutable
       - run: yarn lint:js
         name: Lint JS
         if: always()
@@ -37,4 +38,4 @@ jobs:
         name: Build docs
       - run: node .github/upload-preview.js packages/module/public
         name: Upload docs
-        if: always()
+        if: always()

.github/workflows/promote.yml

@@ -13,12 +13,13 @@ jobs:
       NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
     steps:
       - uses: actions/checkout@v2
-      - name: Build for promotion
-        run: yarn install --frozen-lockfile && yarn build
       - uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version: '20'
           registry-url: 'https://registry.npmjs.org'
+      - run: corepack enable
+      - name: Build for promotion
+        run: yarn install --immutable && yarn build
       - name: GitHub Tag Name example
         run: |
           echo "Tag name from GITHUB_REF_NAME: $GITHUB_REF_NAME"

.github/workflows/release.yml

@@ -14,10 +14,11 @@ jobs:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - run: yarn install --frozen-lockfile
+          node-version: '20'
+      - run: corepack enable
+      - run: yarn install --immutable
       - name: generate
         run: cd packages/module && yarn generate
       - name: Build dist

.gitignore

@@ -14,6 +14,7 @@ coverage
 # package managers
 yarn-error.log
 lerna-debug.log
+.yarn
 
 # IDEs and editors
 .idea

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

README.md

@@ -1,10 +1,10 @@
 # PatternFly Topology
-
+ 
 This package provides the resources necessary to use PatternFly Topology, an open source utility that you can use to create a visual representation of all the applications within your project, their build status, and the components and services associated with them.
 
-Topology utilizes some of PatternFly's React components https://github.com/patternfly/patternfly-react.
+Topology utilizes some of PatternFly's React components https://github.com/patternfly/patternfly-react. 
 
-Documentation for Topology and its features is available on [the PatternFly website.](www.patternfly.org/topology/about-topology)
+Documentation for Topology and its features is available on [the PatternFly website.](www.patternfly.org/extensions/topology/overview)
 
 ## Table of contents
 
@@ -78,7 +78,7 @@ To use Topology out of the box, follow these steps:
 ## Example
 
 ```ts
-import * as React from 'react';
+import { memo, useState, useMemo } from 'react';
 import {
   EdgeStyle,
   Model,
@@ -172,10 +172,10 @@ const EDGES = [
   }
 ];
 
-export const TopologyBaselineDemo = React.memo(() => {
-  const [selectedIds, setSelectedIds] = React.useState<string[]>([]);
+export const TopologyBaselineDemo = memo(() => {
+  const [selectedIds, setSelectedIds] = useState<string[]>([]);
 
-  const controller = React.useMemo(() => {
+  const controller = useMemo(() => {
     const model: Model = {
       nodes: NODES,
       edges: EDGES,
@@ -214,3 +214,9 @@ See the instructions to install and run the demo app, here: [Demo README.md](pac
 ## Need help?
 
 If you find a bug, have a request, or have any questions about Topology that aren't answered in our documentation, please [reach out to us on Slack.](https://patternfly.slack.com/archives/CK7URGJ2W)
+
+## Contributing to Topology
+
+### AI-assisted development guidelines
+
+Please reference [PatternFly's AI-assisted development guidelines](https://github.com/patternfly/.github/blob/main/CONTRIBUTING.md) if you'd like to contribute code generated using AI.

package.json

@@ -26,32 +26,33 @@
   },
   "devDependencies": {
     "@babel/core": "^7.19.6",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-decorators": "^7.21.0",
     "@babel/preset-env": "^7.19.4",
-    "@babel/preset-react": "^7.18.6",
     "@babel/preset-flow": "^7.18.6",
+    "@babel/preset-react": "^7.18.6",
     "@babel/preset-typescript": "^7.18.6",
-    "@babel/plugin-proposal-decorators": "^7.21.0",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@octokit/rest": "^18.0.0",
+    "@testing-library/dom": "9.0.0",
+    "@testing-library/jest-dom": "5.16.5",
     "@testing-library/react": "^13.4.0",
     "@testing-library/user-event": "14.4.3",
-    "@testing-library/jest-dom": "5.16.5",
-    "@testing-library/dom": "9.0.0",
+    "@types/react": "^18",
     "@typescript-eslint/eslint-plugin": "^5.42.0",
     "@typescript-eslint/parser": "^5.42.0",
-    "@octokit/rest": "^18.0.0",
     "babel-jest": "^29.2.2",
     "concurrently": "^5.3.0",
     "eslint": "8.22.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-config-standard-with-typescript": "^23.0.0",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-markdown": "^1.0.2",
-    "eslint-plugin-prettier": "^3.1.4",
-    "eslint-plugin-react": "^7.21.4",
-    "eslint-config-standard-with-typescript": "^23.0.0",
     "eslint-plugin-n": "^15.0.0",
+    "eslint-plugin-patternfly-react": "^4.80.4",
+    "eslint-plugin-prettier": "^3.1.4",
     "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-react": "^7.21.4",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-patternfly-react": "^4.80.4",
     "jest": "^29.2.2",
     "jest-environment-jsdom": "^29.2.2",
     "jest-transform-stub": "^2.0.0",
@@ -60,8 +61,7 @@
     "react-dom": "^18",
     "serve": "^14.1.2",
     "surge": "^0.23.1",
-    "typedoc": "0.23",
-    "@types/react": "^18"
+    "typedoc": "0.23"
   },
-  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+  "packageManager": "yarn@4.10.3"
 }