diff --git a/.github/workflows/autofix.yml b/.github/workflows/autofix.yml new file mode 100644 index 000000000..e6ccf1885 --- /dev/null +++ b/.github/workflows/autofix.yml @@ -0,0 +1,41 @@ +name: autofix.ci # needed to securely identify the workflow + +on: + pull_request: +permissions: + contents: read + +jobs: + autofix: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: pnpm/action-setup@v4 + # uses version from "packageManager" field in package.json + + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + cache: pnpm + node-version-file: '.node-version' + + - name: Install Packages + run: | + pnpm install --frozen-lockfile + env: + CYPRESS_CACHE_FOLDER: .cache/Cypress + + - name: Fix Linting + shell: bash + run: pnpm -w run lint:fix + + - name: Sync `./src/config.type.ts` with `./src/schemas/config.schema.yaml` + shell: bash + run: pnpm run --filter mermaid types:build-config + + - name: Build Docs + working-directory: ./packages/mermaid + run: pnpm run docs:build + + - uses: autofix-ci/action@dd55f44df8f7cdb7a6bf74c78677eb8acd40cd0a diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index ac34067f6..632cd6ddc 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -82,15 +82,3 @@ jobs: working-directory: ./packages/mermaid continue-on-error: ${{ github.event_name == 'push' }} run: pnpm run docs:verify - - - name: Rebuild Docs - if: ${{ steps.verifyDocs.outcome == 'failure' && github.event_name == 'push' }} - working-directory: ./packages/mermaid - run: pnpm run 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/*' diff --git a/docs/syntax/packet.md b/docs/syntax/packet.md index d5decc4fb..3fe7b119e 100644 --- a/docs/syntax/packet.md +++ b/docs/syntax/packet.md @@ -12,7 +12,7 @@ A packet diagram is a visual representation used to illustrate the structure and ## Usage -This diagram type is particularly useful for network engineers, educators, and students who require a clear and concise way to represent the structure of network packets. +This diagram type is particularly useful for developers, network engineers, educators, and students who require a clear and concise way to represent the structure of network packets. ## Syntax diff --git a/packages/mermaid/src/docs/syntax/packet.md b/packages/mermaid/src/docs/syntax/packet.md index 414b173ef..52a0de887 100644 --- a/packages/mermaid/src/docs/syntax/packet.md +++ b/packages/mermaid/src/docs/syntax/packet.md @@ -6,7 +6,7 @@ A packet diagram is a visual representation used to illustrate the structure and ## Usage -This diagram type is particularly useful for network engineers, educators, and students who require a clear and concise way to represent the structure of network packets. +This diagram type is particularly useful for developers, network engineers, educators, and students who require a clear and concise way to represent the structure of network packets. ## Syntax