-
Notifications
You must be signed in to change notification settings - Fork 8.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Automatic Import] add yarn draw-graphs command #191813
Conversation
Pinging @elastic/security-scalability (Team:Security-Scalability) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Just couple of suggestions if you wish to try
x-pack/plugins/integration_assistant/scripts/draw_graphs_script.ts
Outdated
Show resolved
Hide resolved
x-pack/plugins/integration_assistant/scripts/draw_graphs_script.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: cc @P1llus |
## Summary This adds the `yarn draw-graphs` plugin specific command, which is defined in our plugins `package.json`. The command can be run from the root of our plugin, and does not require any additional dependencies. The graphs are added to `docs/imgs` and linked in the README.md of the plugin. The purpose of this PR is not to write a better README or provide any automation of the task itself, that would be separate tasks, but simply allow the creation of graphs to the readme, which can be useful to debug changes to nodes and conditional edges. Examples: ![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16) ![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993) ![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488) ![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5) ![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 1606db8)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
## Summary This adds the `yarn draw-graphs` plugin specific command, which is defined in our plugins `package.json`. The command can be run from the root of our plugin, and does not require any additional dependencies. The graphs are added to `docs/imgs` and linked in the README.md of the plugin. The purpose of this PR is not to write a better README or provide any automation of the task itself, that would be separate tasks, but simply allow the creation of graphs to the readme, which can be useful to debug changes to nodes and conditional edges. Examples: ![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16) ![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993) ![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488) ![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5) ![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 1606db8)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…2433) # Backport This will backport the following commits from `main` to `8.15`: - [[Automatic Import] add yarn draw-graphs command (#191813)](#191813) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Marius Iversen","email":"marius.iversen@elastic.co"},"sourceCommit":{"committedDate":"2024-09-02T11:00:30Z","message":"[Automatic Import] add yarn draw-graphs command (#191813)\n\n## Summary\r\n\r\nThis adds the `yarn draw-graphs` plugin specific command, which is\r\ndefined in our plugins `package.json`. The command can be run from the\r\nroot of our plugin, and does not require any additional dependencies.\r\n\r\nThe graphs are added to `docs/imgs` and linked in the README.md of the\r\nplugin.\r\n\r\nThe purpose of this PR is not to write a better README or provide any\r\nautomation of the task itself, that would be separate tasks, but simply\r\nallow the creation of graphs to the readme, which can be useful to debug\r\nchanges to nodes and conditional edges.\r\n\r\nExamples:\r\n\r\n![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16)\r\n\r\n![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993)\r\n\r\n![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488)\r\n\r\n![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5)\r\n\r\n![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"1606db8ad8040b395c08302e7a3add28907c906a","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["enhancement","release_note:skip","backport:prev-minor","v8.16.0","Team:Security-Scalability"],"title":"[Automatic Import] add yarn draw-graphs command","number":191813,"url":"https://github.com/elastic/kibana/pull/191813","mergeCommit":{"message":"[Automatic Import] add yarn draw-graphs command (#191813)\n\n## Summary\r\n\r\nThis adds the `yarn draw-graphs` plugin specific command, which is\r\ndefined in our plugins `package.json`. The command can be run from the\r\nroot of our plugin, and does not require any additional dependencies.\r\n\r\nThe graphs are added to `docs/imgs` and linked in the README.md of the\r\nplugin.\r\n\r\nThe purpose of this PR is not to write a better README or provide any\r\nautomation of the task itself, that would be separate tasks, but simply\r\nallow the creation of graphs to the readme, which can be useful to debug\r\nchanges to nodes and conditional edges.\r\n\r\nExamples:\r\n\r\n![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16)\r\n\r\n![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993)\r\n\r\n![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488)\r\n\r\n![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5)\r\n\r\n![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"1606db8ad8040b395c08302e7a3add28907c906a"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/191813","number":191813,"mergeCommit":{"message":"[Automatic Import] add yarn draw-graphs command (#191813)\n\n## Summary\r\n\r\nThis adds the `yarn draw-graphs` plugin specific command, which is\r\ndefined in our plugins `package.json`. The command can be run from the\r\nroot of our plugin, and does not require any additional dependencies.\r\n\r\nThe graphs are added to `docs/imgs` and linked in the README.md of the\r\nplugin.\r\n\r\nThe purpose of this PR is not to write a better README or provide any\r\nautomation of the task itself, that would be separate tasks, but simply\r\nallow the creation of graphs to the readme, which can be useful to debug\r\nchanges to nodes and conditional edges.\r\n\r\nExamples:\r\n\r\n![ecs_graph](https://github.com/user-attachments/assets/ccc403a2-e2b0-4482-9de7-74c016c75c16)\r\n\r\n![ecs_subgraph](https://github.com/user-attachments/assets/ad8da90e-191e-4533-b5b2-ede4bd973993)\r\n\r\n![log_detection_graph](https://github.com/user-attachments/assets/777c6845-ba52-4a16-a2b1-b13e172a7488)\r\n\r\n![related_graph](https://github.com/user-attachments/assets/a5447a5b-2fa7-4b96-920f-3cd9a2c8dbe5)\r\n\r\n![categorization_graph](https://github.com/user-attachments/assets/c61463d6-c1d8-4347-bb84-d39e5606417b)\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>","sha":"1606db8ad8040b395c08302e7a3add28907c906a"}}]}] BACKPORT--> Co-authored-by: Marius Iversen <marius.iversen@elastic.co>
Summary
This adds the
yarn draw-graphs
plugin specific command, which is defined in our pluginspackage.json
. The command can be run from the root of our plugin, and does not require any additional dependencies.The graphs are added to
docs/imgs
and linked in the README.md of the plugin.The purpose of this PR is not to write a better README or provide any automation of the task itself, that would be separate tasks, but simply allow the creation of graphs to the readme, which can be useful to debug changes to nodes and conditional edges.
Examples: