docs: clarify EMQX broker dependency and dependent features #613
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Publish Documentation | |
| on: | |
| push: | |
| branches: [ main, maintenance ] | |
| paths: | |
| - 'docs/**' | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| name: Test Documentation links | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| - name: Setup Node | |
| uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 | |
| with: | |
| node-version: 24 | |
| - name: Install Dependencies | |
| run: npm ci | |
| - name: Test Documentation Links | |
| run: npm run test:docs | |
| test-with-website: | |
| runs-on: ubuntu-latest | |
| name: Test Documentation with website | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| path: 'flowfuse' | |
| - name: Check out website repository | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| repository: 'FlowFuse/website' | |
| path: 'website' | |
| - name: Generate a token | |
| id: generate_token | |
| uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0 | |
| with: | |
| app-id: ${{ secrets.GH_BOT_APP_ID }} | |
| private-key: ${{ secrets.GH_BOT_APP_KEY }} | |
| owner: ${{ github.repository_owner }} | |
| repositories: blueprint-library | |
| - name: Check out FlowFuse/blueprint-library repository (to access the blueprints) | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| repository: 'FlowFuse/blueprint-library' | |
| ref: main | |
| path: 'blueprint-library' | |
| token: ${{ steps.generate_token.outputs.token }} | |
| - name: Cache image pipeline output | |
| uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0 | |
| with: | |
| key: img-pipeline-cache | |
| path: website/_site/img | |
| - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 | |
| with: | |
| cache: 'npm' | |
| cache-dependency-path: './website/package-lock.json' | |
| - run: npm run docs | |
| working-directory: 'website' | |
| - run: npm run blueprints | |
| working-directory: 'website' | |
| - name: Install Dependencies | |
| run: npm install | |
| working-directory: 'website' | |
| - name: Build the forge | |
| run: npm run build:nuxt:skip-images | |
| working-directory: 'website' | |
| - uses: untitaker/hyperlink@9375bc4063712ad490d5eb3d54df0b6aade15e54 # 0.3.2 | |
| with: | |
| args: website/nuxt/dist/ --check-anchors --sources website/src | |
| publish: | |
| if: github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| needs: | |
| - test | |
| - test-with-website | |
| name: Publish Documentation | |
| steps: | |
| - name: Generate token | |
| id: generate_token | |
| uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0 | |
| with: | |
| app-id: ${{ secrets.GH_BOT_APP_ID }} | |
| private-key: ${{ secrets.GH_BOT_APP_KEY }} | |
| owner: ${{ github.repository_owner }} | |
| repositories: website | |
| - name: Trigger website rebuild | |
| uses: benc-uk/workflow-dispatch@31e2b3319479a63f0ab15bf800eff9e913504e26 # v1.3.2 | |
| with: | |
| workflow: build.yml | |
| repo: flowfuse/website | |
| ref: main | |
| token: ${{ steps.generate_token.outputs.token }} |