diff --git a/.github/workflows/e2e-timings.yml b/.github/workflows/e2e-timings.yml index b51557b69..4c36bc238 100644 --- a/.github/workflows/e2e-timings.yml +++ b/.github/workflows/e2e-timings.yml @@ -11,6 +11,7 @@ concurrency: ${{ github.workflow }}-${{ github.ref }} permissions: contents: write + pull-requests: write jobs: timings: @@ -44,15 +45,13 @@ jobs: SPLIT: 1 SPLIT_INDEX: 0 SPLIT_FILE: 'cypress/timings.json' - - name: Commit changes - uses: EndBug/add-and-commit@a94899bca583c204427a224a7af87c02f9b325d5 # v9.1.4 + - name: Commit and create pull request + uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e with: - add: 'cypress/timings.json' - author_name: 'github-actions[bot]' - author_email: '41898282+github-actions[bot]@users.noreply.github.com' - message: 'chore: update E2E timings' - - name: Create Pull Request - uses: peter-evans/create-pull-request@v5 - with: - branch: release-promotion + add-paths: | + cypress/timings.json + commit-message: 'chore: update E2E timings' + branch: update-timings title: Update E2E Timings + delete-branch: true + sign-commits: true diff --git a/cypress/timings.json b/cypress/timings.json index 3455d82fc..6164a81fb 100644 --- a/cypress/timings.json +++ b/cypress/timings.json @@ -2,151 +2,211 @@ "durations": [ { "spec": "cypress/integration/other/configuration.spec.js", - "duration": 4989 + "duration": 5475 }, { "spec": "cypress/integration/other/external-diagrams.spec.js", - "duration": 1382 + "duration": 2037 }, { "spec": "cypress/integration/other/ghsa.spec.js", - "duration": 3178 + "duration": 3207 }, { "spec": "cypress/integration/other/iife.spec.js", - "duration": 1372 + "duration": 1915 }, { "spec": "cypress/integration/other/interaction.spec.js", - "duration": 8998 + "duration": 10952 }, { "spec": "cypress/integration/other/rerender.spec.js", - "duration": 1249 + "duration": 1872 }, { "spec": "cypress/integration/other/xss.spec.js", - "duration": 25664 + "duration": 26686 }, { "spec": "cypress/integration/rendering/appli.spec.js", - "duration": 1928 + "duration": 2629 }, { "spec": "cypress/integration/rendering/architecture.spec.ts", - "duration": 2330 + "duration": 104 }, { "spec": "cypress/integration/rendering/block.spec.js", - "duration": 11156 + "duration": 14765 }, { "spec": "cypress/integration/rendering/c4.spec.js", - "duration": 3418 + "duration": 4913 + }, + { + "spec": "cypress/integration/rendering/classDiagram-elk-v3.spec.js", + "duration": 36667 + }, + { + "spec": "cypress/integration/rendering/classDiagram-handDrawn-v3.spec.js", + "duration": 33813 }, { "spec": "cypress/integration/rendering/classDiagram-v2.spec.js", - "duration": 14866 + "duration": 20441 + }, + { + "spec": "cypress/integration/rendering/classDiagram-v3.spec.js", + "duration": 32504 }, { "spec": "cypress/integration/rendering/classDiagram.spec.js", - "duration": 9894 + "duration": 13772 }, { "spec": "cypress/integration/rendering/conf-and-directives.spec.js", - "duration": 5778 + "duration": 7978 }, { "spec": "cypress/integration/rendering/current.spec.js", - "duration": 1690 + "duration": 2101 + }, + { + "spec": "cypress/integration/rendering/erDiagram-unified.spec.js", + "duration": 76556 }, { "spec": "cypress/integration/rendering/erDiagram.spec.js", - "duration": 9144 + "duration": 12756 }, { "spec": "cypress/integration/rendering/errorDiagram.spec.js", - "duration": 1951 + "duration": 2766 }, { "spec": "cypress/integration/rendering/flowchart-elk.spec.js", - "duration": 2196 + "duration": 35641 }, { "spec": "cypress/integration/rendering/flowchart-handDrawn.spec.js", - "duration": 21029 + "duration": 26915 }, { "spec": "cypress/integration/rendering/flowchart-shape-alias.spec.ts", - "duration": 16087 + "duration": 21171 }, { "spec": "cypress/integration/rendering/flowchart-v2.spec.js", - "duration": 27465 + "duration": 37844 }, { "spec": "cypress/integration/rendering/flowchart.spec.js", - "duration": 20035 + "duration": 26254 }, { "spec": "cypress/integration/rendering/gantt.spec.js", - "duration": 11366 + "duration": 15149 }, { "spec": "cypress/integration/rendering/gitGraph.spec.js", - "duration": 34025 + "duration": 45049 }, { "spec": "cypress/integration/rendering/iconShape.spec.ts", - "duration": 185902 + "duration": 250225 }, { "spec": "cypress/integration/rendering/imageShape.spec.ts", - "duration": 41631 + "duration": 51531 }, { "spec": "cypress/integration/rendering/info.spec.ts", - "duration": 1736 + "duration": 2455 }, { "spec": "cypress/integration/rendering/journey.spec.js", - "duration": 2247 + "duration": 3181 + }, + { + "spec": "cypress/integration/rendering/kanban.spec.ts", + "duration": 6298 }, { "spec": "cypress/integration/rendering/katex.spec.js", - "duration": 2144 + "duration": 3065 }, { "spec": "cypress/integration/rendering/marker_unique_id.spec.js", - "duration": 1646 + "duration": 2521 }, { "spec": "cypress/integration/rendering/mindmap.spec.ts", - "duration": 6406 + "duration": 9341 }, { "spec": "cypress/integration/rendering/newShapes.spec.ts", - "duration": 107219 + "duration": 132809 + }, + { + "spec": "cypress/integration/rendering/oldShapes.spec.ts", + "duration": 101299 + }, + { + "spec": "cypress/integration/rendering/packet.spec.ts", + "duration": 3481 + }, + { + "spec": "cypress/integration/rendering/pie.spec.ts", + "duration": 4878 + }, + { + "spec": "cypress/integration/rendering/quadrantChart.spec.js", + "duration": 7416 + }, + { + "spec": "cypress/integration/rendering/radar.spec.js", + "duration": 4554 + }, + { + "spec": "cypress/integration/rendering/requirement.spec.js", + "duration": 2068 + }, + { + "spec": "cypress/integration/rendering/requirementDiagram-unified.spec.js", + "duration": 47583 + }, + { + "spec": "cypress/integration/rendering/sankey.spec.ts", + "duration": 5792 + }, + { + "spec": "cypress/integration/rendering/sequencediagram.spec.js", + "duration": 33035 + }, + { + "spec": "cypress/integration/rendering/stateDiagram-v2.spec.js", + "duration": 22716 }, { "spec": "cypress/integration/rendering/stateDiagram.spec.js", - "duration": 15834 + "duration": 13868 }, { "spec": "cypress/integration/rendering/theme.spec.js", - "duration": 33240 + "duration": 26376 }, { "spec": "cypress/integration/rendering/timeline.spec.ts", - "duration": 7122 + "duration": 5872 }, { "spec": "cypress/integration/rendering/xyChart.spec.js", - "duration": 11127 + "duration": 9469 }, { "spec": "cypress/integration/rendering/zenuml.spec.js", - "duration": 2391 + "duration": 2742 } ] } diff --git a/docs/syntax/entityRelationshipDiagram.md b/docs/syntax/entityRelationshipDiagram.md index 3dec08524..4ec776c10 100644 --- a/docs/syntax/entityRelationshipDiagram.md +++ b/docs/syntax/entityRelationshipDiagram.md @@ -625,17 +625,43 @@ erDiagram ## Configuration -### Renderer +### Layout -The layout of the diagram is done with the renderer. The default renderer is dagre. +The layout of the diagram is handled by [`render()`](../config/setup/mermaid/interfaces/Mermaid.md#render). The default layout is dagre. -You can opt to use an alternate renderer named elk by editing the configuration. The elk renderer is better for larger and/or more complex diagrams. +For larger or more-complex diagrams, you can alternatively apply the ELK (Eclipse Layout Kernel) layout using your YAML frontmatter's `config`. For more information, see [Customizing ELK Layout](../intro/syntax-reference.md#customizing-elk-layout). +```yaml +--- +config: + layout: elk +--- ``` + +Your Mermaid code should be similar to the following: + +```mermaid-example --- - config: - layout: elk +title: Order example +config: + layout: elk --- +erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + CUSTOMER }|..|{ DELIVERY-ADDRESS : uses +``` + +```mermaid +--- +title: Order example +config: + layout: elk +--- +erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + CUSTOMER }|..|{ DELIVERY-ADDRESS : uses ``` > **Note** diff --git a/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md b/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md index 46fb7ee86..600d50723 100644 --- a/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md +++ b/packages/mermaid/src/docs/syntax/entityRelationshipDiagram.md @@ -407,17 +407,31 @@ erDiagram ## Configuration -### Renderer +### Layout -The layout of the diagram is done with the renderer. The default renderer is dagre. +The layout of the diagram is handled by [`render()`](../config/setup/mermaid/interfaces/Mermaid.md#render). The default layout is dagre. -You can opt to use an alternate renderer named elk by editing the configuration. The elk renderer is better for larger and/or more complex diagrams. +For larger or more-complex diagrams, you can alternatively apply the ELK (Eclipse Layout Kernel) layout using your YAML frontmatter's `config`. For more information, see [Customizing ELK Layout](../intro/syntax-reference.md#customizing-elk-layout). +```yaml +--- +config: + layout: elk +--- ``` + +Your Mermaid code should be similar to the following: + +```mermaid-example --- - config: - layout: elk +title: Order example +config: + layout: elk --- +erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + CUSTOMER }|..|{ DELIVERY-ADDRESS : uses ``` ```note