Add syntax & type check for Node.js example on CI #10271
Workflow file for this run
This file contains 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: Static Analysis | |
| on: | |
| pull_request: {} | |
| merge_group: | |
| types: [checks_requested] | |
| push: | |
| branches: [develop, master] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| ts_lint: | |
| name: "Typescript Syntax Check" | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version-file: package.json | |
| - name: Install Deps | |
| run: "yarn install" | |
| - name: Typecheck | |
| run: "yarn run lint:types" | |
| js_lint: | |
| name: "ESLint" | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version-file: package.json | |
| - name: Install Deps | |
| run: "yarn install" | |
| - name: Run Linter | |
| run: "yarn run lint:js" | |
| node_example_lint: | |
| name: "Node.js example" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version-file: package.json | |
| - name: Install Deps | |
| run: "yarn install" | |
| - name: Build Types | |
| run: "yarn build:types" | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "npm" | |
| node-version-file: "examples/node/package.json" | |
| # cache-dependency-path: '**/package-lock.json' | |
| - name: Install Example Deps | |
| run: "npm install" | |
| working-directory: "examples/node" | |
| - name: Check Syntax | |
| run: "node --check app.js" | |
| working-directory: "examples/node" | |
| - name: Typecheck | |
| run: "npx tsc" | |
| working-directory: "examples/node" | |
| workflow_lint: | |
| name: "Workflow Lint" | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version-file: package.json | |
| - name: Install Deps | |
| run: "yarn install --frozen-lockfile" | |
| - name: Run Linter | |
| run: "yarn lint:workflows" | |
| docs: | |
| name: "JSDoc Checker" | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version-file: package.json | |
| - name: Install Deps | |
| run: "yarn install" | |
| - name: Generate Docs | |
| run: "yarn run gendoc --treatWarningsAsErrors --suppressCommentWarningsInDeclarationFiles" | |
| - name: Upload Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs | |
| path: _docs | |
| # We'll only use this in a workflow_run, then we're done with it | |
| retention-days: 1 | |
| analyse_dead_code: | |
| name: "Analyse Dead Code" | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version-file: package.json | |
| - name: Install Deps | |
| run: "yarn install --frozen-lockfile" | |
| - name: Run linter | |
| run: "yarn run lint:knip" | |
| element-web: | |
| name: Downstream tsc element-web | |
| if: github.event_name == 'merge_group' | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| repository: element-hq/element-web | |
| - uses: actions/setup-node@v4 | |
| with: | |
| cache: "yarn" | |
| node-version: "lts/*" | |
| - name: Install Dependencies | |
| run: "./scripts/layered.sh" | |
| env: | |
| # tell layered.sh to check out the right sha of the JS-SDK | |
| JS_SDK_GITHUB_BASE_REF: ${{ github.sha }} | |
| - name: Typecheck | |
| run: "yarn run lint:types" | |
| # Hook for branch protection to skip downstream typechecking outside of merge queues | |
| downstream: | |
| name: Downstream Typescript Syntax Check | |
| runs-on: ubuntu-24.04 | |
| if: always() | |
| needs: | |
| - element-web | |
| steps: | |
| - if: needs.element-web.result != 'skipped' && needs.element-web.result != 'success' | |
| run: exit 1 |