From 21caa3eb727d056ef424df0c76afa5069290d105 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 11:50:42 +0800 Subject: [PATCH 01/16] chore: Auto build docs if only src/docs is changed --- .github/workflows/lint.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 44e2f4cb1..c84632264 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -19,6 +19,16 @@ jobs: node-version: [16.x] steps: - uses: actions/checkout@v3 + if: ${{ github.event_name == 'pull_request' }} + with: + fetch-depth: 2 + repository: ${{ github.event.pull_request.head.repo.full_name }} + ref: ${{ github.event.pull_request.head.ref }} + + - uses: actions/checkout@v3 + if: ${{ github.event_name != 'pull_request' }} + with: + fetch-depth: 2 - name: Setup Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 @@ -38,5 +48,27 @@ jobs: - name: Run Linting run: yarn lint + - name: Run changed-files using the fork point of a pull request + id: changed-files-fork-point + uses: tj-actions/changed-files@v29 + with: + use_fork_point: 'true' + files: | + src/docs/* + + - name: Run step if any file(s) in the docs folder change + if: steps.changed-files-fork-point.outputs.only_modified == 'true' + run: | + echo "Only files in the src/docs folder has changed." + echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}" + yarn docs:build + + - name: Commit changes + uses: EndBug/add-and-commit@v9 + if: steps.changed-files-fork-point.outputs.only_modified == 'true' + with: + message: 'Update docs' + add: 'docs/*' + - name: Verify Docs run: yarn docs:verify From 058f1c2edf4908f0bbb63e955bee6e6e359f7caf Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 11:55:33 +0800 Subject: [PATCH 02/16] chore: Update docs path --- .github/workflows/lint.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index aa80e5c6e..13b2c4ebe 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -54,7 +54,7 @@ jobs: with: use_fork_point: 'true' files: | - src/docs/* + packages/mermaid/src/docs/* - name: Run step if any file(s) in the docs folder change if: steps.changed-files-fork-point.outputs.only_modified == 'true' @@ -68,7 +68,7 @@ jobs: if: steps.changed-files-fork-point.outputs.only_modified == 'true' with: message: 'Update docs' - add: 'docs/*' + add: 'packages/mermaid/docs/*' - name: Verify Docs run: pnpm run docs:verify From 8d9800c72709206a182db190df5b4e0447d79aa4 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 11:57:19 +0800 Subject: [PATCH 03/16] fix(docs): Test auto commit --- packages/mermaid/src/docs/classDiagram.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/mermaid/src/docs/classDiagram.md b/packages/mermaid/src/docs/classDiagram.md index f46d3689c..51383fb6a 100644 --- a/packages/mermaid/src/docs/classDiagram.md +++ b/packages/mermaid/src/docs/classDiagram.md @@ -1,7 +1,8 @@ # Class diagrams > "In software engineering, a class diagram in the Unified Modeling Language (UML) is a type of static structure diagram that describes the structure of a system by showing the system's classes, their attributes, operations (or methods), and the relationships among objects." -> Wikipedia +> +> -Wikipedia The class diagram is the main building block of object-oriented modeling. It is used for general conceptual modeling of the structure of the application, and for detailed modeling to translate the models into programming code. Class diagrams can also be used for data modeling. The classes in a class diagram represent both the main elements, interactions in the application, and the classes to be programmed. From d367e832bed51bd60204316f1765f4df2e863619 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 12:00:59 +0800 Subject: [PATCH 04/16] fix(docs): Test auto commit --- .github/workflows/lint.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 13b2c4ebe..c0b0a7f28 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -21,9 +21,9 @@ jobs: - uses: actions/checkout@v3 if: ${{ github.event_name == 'pull_request' }} with: + # repository: ${{ github.event.pull_request.head.repo.full_name }} + # ref: ${{ github.event.pull_request.head.ref }} fetch-depth: 2 - repository: ${{ github.event.pull_request.head.repo.full_name }} - ref: ${{ github.event.pull_request.head.ref }} - uses: actions/checkout@v3 if: ${{ github.event_name != 'pull_request' }} From 75db08a60c944e749b5fac5558dc49725fbe858f Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 12:05:48 +0800 Subject: [PATCH 05/16] fix(docs): Test auto commit --- .github/workflows/lint.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index c0b0a7f28..fc1121c71 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -57,7 +57,7 @@ jobs: packages/mermaid/src/docs/* - name: Run step if any file(s) in the docs folder change - if: steps.changed-files-fork-point.outputs.only_modified == 'true' + if: steps.changed-files-fork-point.outputs.any_modified == 'true' run: | echo "Only files in the src/docs folder has changed." echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}" @@ -65,7 +65,7 @@ jobs: - name: Commit changes uses: EndBug/add-and-commit@v9 - if: steps.changed-files-fork-point.outputs.only_modified == 'true' + if: steps.changed-files-fork-point.outputs.any_modified == 'true' with: message: 'Update docs' add: 'packages/mermaid/docs/*' From 1d8d677d81570628545437ff2adb487dc6c0d51e Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 14:03:44 +0800 Subject: [PATCH 06/16] fix: File location --- .github/workflows/lint.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index fc1121c71..6ca6b3519 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -55,6 +55,7 @@ jobs: use_fork_point: 'true' files: | packages/mermaid/src/docs/* + packages/mermaid/src/docs.mts - name: Run step if any file(s) in the docs folder change if: steps.changed-files-fork-point.outputs.any_modified == 'true' @@ -68,7 +69,7 @@ jobs: if: steps.changed-files-fork-point.outputs.any_modified == 'true' with: message: 'Update docs' - add: 'packages/mermaid/docs/*' + add: 'docs/*' - name: Verify Docs run: pnpm run docs:verify From 3bae25fe6b353d3621ab4e68d3eee47b47ed8305 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 14:15:28 +0800 Subject: [PATCH 07/16] split lint docs action --- .github/workflows/lint-docs.yml | 63 +++++++++++++++++++++++++++++++++ .github/workflows/lint.yml | 33 ----------------- 2 files changed, 63 insertions(+), 33 deletions(-) create mode 100644 .github/workflows/lint-docs.yml diff --git a/.github/workflows/lint-docs.yml b/.github/workflows/lint-docs.yml new file mode 100644 index 000000000..68bda942a --- /dev/null +++ b/.github/workflows/lint-docs.yml @@ -0,0 +1,63 @@ +name: Lint Docs + +on: + pull_request: + types: + - opened + - synchronize + - ready_for_review + +permissions: + contents: write + +jobs: + lint: + runs-on: ubuntu-latest + strategy: + matrix: + node-version: [16.x] + steps: + - uses: actions/checkout@v3 + if: ${{ github.event_name == 'pull_request' }} + with: + repository: ${{ github.event.pull_request.head.repo.full_name }} + ref: ${{ github.event.pull_request.head.ref }} + fetch-depth: 0 + + - uses: pnpm/action-setup@v2 + # uses version from "packageManager" field in package.json + + - name: Setup Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v3 + with: + cache: pnpm + node-version: ${{ matrix.node-version }} + + - name: Install Packages + run: | + pnpm install --frozen-lockfile + env: + CYPRESS_CACHE_FOLDER: .cache/Cypress + + - name: Run changed-files using the fork point of a pull request + id: changed-files-fork-point + uses: tj-actions/changed-files@v29 + with: + use_fork_point: 'true' + files: | + packages/mermaid/src/docs/* + packages/mermaid/src/docs.mts + + - name: Run step if any file(s) in the docs folder change + if: steps.changed-files-fork-point.outputs.any_modified == 'true' + run: | + echo "Only files in the src/docs folder has changed." + echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}" + yarn docs:build + + - name: Commit changes + uses: EndBug/add-and-commit@v9 + if: steps.changed-files-fork-point.outputs.any_modified == 'true' + with: + message: 'Update docs' + add: 'docs/*' diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 6ca6b3519..dd2f7aa3b 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -19,16 +19,6 @@ jobs: node-version: [16.x] steps: - uses: actions/checkout@v3 - if: ${{ github.event_name == 'pull_request' }} - with: - # repository: ${{ github.event.pull_request.head.repo.full_name }} - # ref: ${{ github.event.pull_request.head.ref }} - fetch-depth: 2 - - - uses: actions/checkout@v3 - if: ${{ github.event_name != 'pull_request' }} - with: - fetch-depth: 2 - uses: pnpm/action-setup@v2 # uses version from "packageManager" field in package.json @@ -48,28 +38,5 @@ jobs: - name: Run Linting run: pnpm run lint - - name: Run changed-files using the fork point of a pull request - id: changed-files-fork-point - uses: tj-actions/changed-files@v29 - with: - use_fork_point: 'true' - files: | - packages/mermaid/src/docs/* - packages/mermaid/src/docs.mts - - - name: Run step if any file(s) in the docs folder change - if: steps.changed-files-fork-point.outputs.any_modified == 'true' - run: | - echo "Only files in the src/docs folder has changed." - echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}" - yarn docs:build - - - name: Commit changes - uses: EndBug/add-and-commit@v9 - if: steps.changed-files-fork-point.outputs.any_modified == 'true' - with: - message: 'Update docs' - add: 'docs/*' - - name: Verify Docs run: pnpm run docs:verify From 8d6af3dfedd7fb564e889496db6e2e12e1eec012 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 14:21:54 +0800 Subject: [PATCH 08/16] split lint docs action --- .github/workflows/lint-docs.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/lint-docs.yml b/.github/workflows/lint-docs.yml index 68bda942a..60faeda31 100644 --- a/.github/workflows/lint-docs.yml +++ b/.github/workflows/lint-docs.yml @@ -20,8 +20,8 @@ jobs: - uses: actions/checkout@v3 if: ${{ github.event_name == 'pull_request' }} with: - repository: ${{ github.event.pull_request.head.repo.full_name }} - ref: ${{ github.event.pull_request.head.ref }} + # repository: ${{ github.event.pull_request.head.repo.full_name }} + # ref: ${{ github.event.pull_request.head.ref }} fetch-depth: 0 - uses: pnpm/action-setup@v2 @@ -49,7 +49,7 @@ jobs: packages/mermaid/src/docs.mts - name: Run step if any file(s) in the docs folder change - if: steps.changed-files-fork-point.outputs.any_modified == 'true' + if: steps.changed-files-fork-point.outputs.only_modified == 'true' run: | echo "Only files in the src/docs folder has changed." echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}" @@ -57,7 +57,7 @@ jobs: - name: Commit changes uses: EndBug/add-and-commit@v9 - if: steps.changed-files-fork-point.outputs.any_modified == 'true' + if: steps.changed-files-fork-point.outputs.only_modified == 'true' with: message: 'Update docs' add: 'docs/*' From 9c5c85d34ac1777a93b8e80b15720a5fccbeb57c Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 14:24:51 +0800 Subject: [PATCH 09/16] Run doc lint only if files changed --- .github/workflows/lint-docs.yml | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/.github/workflows/lint-docs.yml b/.github/workflows/lint-docs.yml index 60faeda31..734363a22 100644 --- a/.github/workflows/lint-docs.yml +++ b/.github/workflows/lint-docs.yml @@ -24,21 +24,6 @@ jobs: # ref: ${{ github.event.pull_request.head.ref }} fetch-depth: 0 - - uses: pnpm/action-setup@v2 - # uses version from "packageManager" field in package.json - - - name: Setup Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3 - with: - cache: pnpm - node-version: ${{ matrix.node-version }} - - - name: Install Packages - run: | - pnpm install --frozen-lockfile - env: - CYPRESS_CACHE_FOLDER: .cache/Cypress - - name: Run changed-files using the fork point of a pull request id: changed-files-fork-point uses: tj-actions/changed-files@v29 @@ -48,6 +33,24 @@ jobs: packages/mermaid/src/docs/* packages/mermaid/src/docs.mts + - uses: pnpm/action-setup@v2 + if: steps.changed-files-fork-point.outputs.only_modified == 'true' + # uses version from "packageManager" field in package.json + + - name: Setup Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v3 + if: steps.changed-files-fork-point.outputs.only_modified == 'true' + with: + cache: pnpm + node-version: ${{ matrix.node-version }} + + - name: Install Packages + if: steps.changed-files-fork-point.outputs.only_modified == 'true' + run: | + pnpm install --frozen-lockfile + env: + CYPRESS_CACHE_FOLDER: .cache/Cypress + - name: Run step if any file(s) in the docs folder change if: steps.changed-files-fork-point.outputs.only_modified == 'true' run: | From 0a547e524e1b6f9b98489a847670dea6733d10ab Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 14:30:46 +0800 Subject: [PATCH 10/16] Run doc lint only if files changed --- .github/workflows/lint-docs.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/lint-docs.yml b/.github/workflows/lint-docs.yml index 734363a22..20caab6f0 100644 --- a/.github/workflows/lint-docs.yml +++ b/.github/workflows/lint-docs.yml @@ -18,17 +18,17 @@ jobs: node-version: [16.x] steps: - uses: actions/checkout@v3 - if: ${{ github.event_name == 'pull_request' }} - with: - # repository: ${{ github.event.pull_request.head.repo.full_name }} - # ref: ${{ github.event.pull_request.head.ref }} - fetch-depth: 0 + # if: ${{ github.event_name == 'pull_request' }} + # with: + # fetch-depth: 0 + # repository: ${{ github.event.pull_request.head.repo.full_name }} + # ref: ${{ github.event.pull_request.head.ref }} - name: Run changed-files using the fork point of a pull request id: changed-files-fork-point uses: tj-actions/changed-files@v29 with: - use_fork_point: 'true' + # use_fork_point: 'true' files: | packages/mermaid/src/docs/* packages/mermaid/src/docs.mts From 455c61b2cf38fd8c9739a3b97029cb935574c168 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 14:41:52 +0800 Subject: [PATCH 11/16] Run doc lint only if files changed --- .github/workflows/lint-docs.yml | 24 ++++++++++-------------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/.github/workflows/lint-docs.yml b/.github/workflows/lint-docs.yml index 20caab6f0..312de8b1c 100644 --- a/.github/workflows/lint-docs.yml +++ b/.github/workflows/lint-docs.yml @@ -18,41 +18,37 @@ jobs: node-version: [16.x] steps: - uses: actions/checkout@v3 - # if: ${{ github.event_name == 'pull_request' }} - # with: - # fetch-depth: 0 - # repository: ${{ github.event.pull_request.head.repo.full_name }} - # ref: ${{ github.event.pull_request.head.ref }} + with: + repository: ${{ github.event.pull_request.head.repo.full_name }} + ref: ${{ github.event.pull_request.head.ref }} - - name: Run changed-files using the fork point of a pull request - id: changed-files-fork-point + - name: Check if source docs are changed + id: changed-docs uses: tj-actions/changed-files@v29 with: - # use_fork_point: 'true' files: | packages/mermaid/src/docs/* packages/mermaid/src/docs.mts - uses: pnpm/action-setup@v2 - if: steps.changed-files-fork-point.outputs.only_modified == 'true' - # uses version from "packageManager" field in package.json + if: steps.changed-docs.outputs.only_modified == 'true' - name: Setup Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 - if: steps.changed-files-fork-point.outputs.only_modified == 'true' + if: steps.changed-docs.outputs.only_modified == 'true' with: cache: pnpm node-version: ${{ matrix.node-version }} - name: Install Packages - if: steps.changed-files-fork-point.outputs.only_modified == 'true' + if: steps.changed-docs.outputs.only_modified == 'true' run: | pnpm install --frozen-lockfile env: CYPRESS_CACHE_FOLDER: .cache/Cypress - name: Run step if any file(s) in the docs folder change - if: steps.changed-files-fork-point.outputs.only_modified == 'true' + if: steps.changed-docs.outputs.only_modified == 'true' run: | echo "Only files in the src/docs folder has changed." echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}" @@ -60,7 +56,7 @@ jobs: - name: Commit changes uses: EndBug/add-and-commit@v9 - if: steps.changed-files-fork-point.outputs.only_modified == 'true' + if: steps.changed-docs.outputs.only_modified == 'true' with: message: 'Update docs' add: 'docs/*' From 563c51d4311f1ff8b159355f8553905348d4b86a Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 3 Oct 2022 14:49:35 +0800 Subject: [PATCH 12/16] Get base sha from PR --- .github/workflows/lint-docs.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/workflows/lint-docs.yml b/.github/workflows/lint-docs.yml index 312de8b1c..d9f0ddae0 100644 --- a/.github/workflows/lint-docs.yml +++ b/.github/workflows/lint-docs.yml @@ -22,10 +22,22 @@ jobs: repository: ${{ github.event.pull_request.head.repo.full_name }} ref: ${{ github.event.pull_request.head.ref }} + - name: Get branch name + id: branch-name + uses: tj-actions/branch-names@v5 + + - uses: nrwl/last-successful-commit-action@v1 + id: last_successful_commit_pull_request + with: + branch: ${{ steps.branch-name.outputs.base_ref_branch }} + workflow_id: 'lint-docs.yml' + github_token: ${{ secrets.GITHUB_TOKEN }} + - name: Check if source docs are changed id: changed-docs uses: tj-actions/changed-files@v29 with: + base_sha: ${{ steps.last_successful_commit_pull_request.outputs.commit_hash }} files: | packages/mermaid/src/docs/* packages/mermaid/src/docs.mts From 792c1a8320fa12519b9d59acffa729917fc4ebe5 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Wed, 7 Dec 2022 11:19:44 +0530 Subject: [PATCH 13/16] chore: Rebuild docs if linting fails --- .github/workflows/lint-docs.yml | 74 --------------------------------- .github/workflows/lint.yml | 16 ++++++- 2 files changed, 15 insertions(+), 75 deletions(-) delete mode 100644 .github/workflows/lint-docs.yml diff --git a/.github/workflows/lint-docs.yml b/.github/workflows/lint-docs.yml deleted file mode 100644 index d9f0ddae0..000000000 --- a/.github/workflows/lint-docs.yml +++ /dev/null @@ -1,74 +0,0 @@ -name: Lint Docs - -on: - pull_request: - types: - - opened - - synchronize - - ready_for_review - -permissions: - contents: write - -jobs: - lint: - runs-on: ubuntu-latest - strategy: - matrix: - node-version: [16.x] - steps: - - uses: actions/checkout@v3 - with: - repository: ${{ github.event.pull_request.head.repo.full_name }} - ref: ${{ github.event.pull_request.head.ref }} - - - name: Get branch name - id: branch-name - uses: tj-actions/branch-names@v5 - - - uses: nrwl/last-successful-commit-action@v1 - id: last_successful_commit_pull_request - with: - branch: ${{ steps.branch-name.outputs.base_ref_branch }} - workflow_id: 'lint-docs.yml' - github_token: ${{ secrets.GITHUB_TOKEN }} - - - name: Check if source docs are changed - id: changed-docs - uses: tj-actions/changed-files@v29 - with: - base_sha: ${{ steps.last_successful_commit_pull_request.outputs.commit_hash }} - files: | - packages/mermaid/src/docs/* - packages/mermaid/src/docs.mts - - - uses: pnpm/action-setup@v2 - if: steps.changed-docs.outputs.only_modified == 'true' - - - name: Setup Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v3 - if: steps.changed-docs.outputs.only_modified == 'true' - with: - cache: pnpm - node-version: ${{ matrix.node-version }} - - - name: Install Packages - if: steps.changed-docs.outputs.only_modified == 'true' - run: | - pnpm install --frozen-lockfile - env: - CYPRESS_CACHE_FOLDER: .cache/Cypress - - - name: Run step if any file(s) in the docs folder change - if: steps.changed-docs.outputs.only_modified == 'true' - run: | - echo "Only files in the src/docs folder has changed." - echo "List all the files that have changed: ${{ steps.changed-files-specific.outputs.all_changed_files }}" - yarn docs:build - - - name: Commit changes - uses: EndBug/add-and-commit@v9 - if: steps.changed-docs.outputs.only_modified == 'true' - with: - message: 'Update docs' - add: 'docs/*' diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 8ba06989d..917a2731c 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -9,7 +9,7 @@ on: - ready_for_review permissions: - contents: read + contents: write jobs: lint: @@ -39,5 +39,19 @@ jobs: run: pnpm run lint - name: Verify Docs + id: verifyDocs working-directory: ./packages/mermaid + continue-on-error: true run: pnpm run docs:verify + + - name: Rebuild Docs + if: ${{ steps.verifyDocs.outcome == 'failure' && github.event_name == 'push' }} + run: | + yarn docs:build + + - name: Commit changes + uses: EndBug/add-and-commit@v9 + if: ${{ steps.verifyDocs.outcome == 'failure' && github.event_name == 'push' }} + with: + message: 'Update docs' + add: 'docs/*' From 755382798589f28c936300c311589a4606a1f9a0 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Wed, 7 Dec 2022 11:40:17 +0530 Subject: [PATCH 14/16] fix: docs build command --- .github/workflows/lint.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 917a2731c..f1ab5726b 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -46,8 +46,8 @@ jobs: - name: Rebuild Docs if: ${{ steps.verifyDocs.outcome == 'failure' && github.event_name == 'push' }} - run: | - yarn docs:build + working-directory: ./packages/mermaid + run: pnpm run docs:build - name: Commit changes uses: EndBug/add-and-commit@v9 From b2489523f24ed271e7c9dc281078e859e6026619 Mon Sep 17 00:00:00 2001 From: sidharthv96 Date: Wed, 7 Dec 2022 06:13:07 +0000 Subject: [PATCH 15/16] Update docs --- docs/syntax/classDiagram.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/syntax/classDiagram.md b/docs/syntax/classDiagram.md index 5870d0743..b6d48c9de 100644 --- a/docs/syntax/classDiagram.md +++ b/docs/syntax/classDiagram.md @@ -7,7 +7,8 @@ # Class diagrams > "In software engineering, a class diagram in the Unified Modeling Language (UML) is a type of static structure diagram that describes the structure of a system by showing the system's classes, their attributes, operations (or methods), and the relationships among objects." -> Wikipedia +> +> \-Wikipedia The class diagram is the main building block of object-oriented modeling. It is used for general conceptual modeling of the structure of the application, and for detailed modeling to translate the models into programming code. Class diagrams can also be used for data modeling. The classes in a class diagram represent both the main elements, interactions in the application, and the classes to be programmed. From 1a767ee492f74aa3475cf50ecc0baf0f10545d3e Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Wed, 7 Dec 2022 11:48:51 +0530 Subject: [PATCH 16/16] chore: Update cspell --- cSpell.json | 1 + 1 file changed, 1 insertion(+) diff --git a/cSpell.json b/cSpell.json index 64187e1ca..3ddf84102 100644 --- a/cSpell.json +++ b/cSpell.json @@ -64,6 +64,7 @@ "phpbb", "plantuml", "playfair", + "pnpm", "podlite", "ranksep", "redmine",