feat: add type declarations for configs #757
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: Checks | |
| on: [pull_request] | |
| concurrency: | |
| # Pushing new changes to a branch will cancel any in-progress CI runs of this workflow | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| # Restrict jobs in this workflow to have no permissions by default; permissions | |
| # should be granted per job as needed using a dedicated `permissions` block | |
| permissions: {} | |
| env: | |
| # reduces noise from npm post-install scripts | |
| DISABLE_OPENCOLLECTIVE: true | |
| OPEN_SOURCE_CONTRIBUTOR: true | |
| jobs: | |
| commitlint: | |
| permissions: | |
| contents: read # to fetch code (actions/checkout) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Commit Linter | |
| uses: wagoid/commitlint-github-action@v6 | |
| with: | |
| configFile: './package.json' | |
| docs: | |
| permissions: | |
| contents: read # to fetch code (actions/checkout) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.x | |
| cache: npm | |
| - name: install | |
| run: npm ci | |
| - name: regenerate docs | |
| run: npm run tools:generate-configs-list | |
| - name: report regenerated docs | |
| run: | | |
| git diff --name-only \ | |
| | xargs -I '{}' bash -c \ | |
| 'echo "::error file={}::This needs to be regenerated by running \`tools:generate-configs-list\`" && false' | |
| lint: | |
| permissions: | |
| contents: read # to fetch code (actions/checkout) | |
| # prettier-ignore | |
| name: Lint on ${{ matrix.os }} with eslint v${{ matrix.eslint }}, @typescript-eslint v${{ matrix.typescript-eslint }}, eslint-plugin-jest v${{ matrix.jest-eslint }}, and using Node.js LTS | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| eslint: [7, 8] | |
| typescript-eslint: [6, 7] | |
| jest-eslint: [27, 28] | |
| os: [ubuntu-latest, macOS-latest] | |
| exclude: | |
| - eslint: 7 | |
| typescript-eslint: 7 | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.x | |
| cache: npm | |
| - run: npm ci | |
| # prettier-ignore | |
| - run: npm install eslint@${{ matrix.eslint }} @typescript-eslint/parser@${{ matrix.typescript-eslint }} @typescript-eslint/eslint-plugin@${{ matrix.typescript-eslint }} eslint-plugin-jest@${{ matrix.jest-eslint }} --no-fund | |
| - run: npm run lint | |
| test: | |
| permissions: | |
| contents: read # to fetch code (actions/checkout) | |
| name: Test on ${{ matrix.os }} using Node.js LTS | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macOS-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.x | |
| cache: npm | |
| - run: npm ci | |
| - run: npm run test | |
| typecheck: | |
| permissions: | |
| contents: read # to fetch code (actions/checkout) | |
| name: Typecheck on ${{ matrix.os }} using Node.js LTS | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest, macOS-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20.x | |
| cache: npm | |
| - run: npm ci | |
| - run: npm run typecheck | |