docs: add inline documentation for CustomPrefixProvider #509
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: CI | |
| on: [push, pull_request] | |
| jobs: | |
| # Check commit lint, code lint, formatting etc. | |
| # Used to validate before continuing the full build and test matrix. | |
| validate: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v4 | |
| - name: Lint Commits against conventional commits spec with commitlint | |
| uses: wagoid/commitlint-github-action@v6 | |
| with: | |
| configFile: commitlint.config.ts | |
| - name: Setup Node.js 22.x | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 22.x | |
| cache: 'npm' | |
| - name: Install dependencies | |
| run: npm ci | |
| - name: Lint Code with ESLint | |
| run: npm run lint | |
| - name: Check Code Formatting with Prettier | |
| run: npm run format:check | |
| - name: Validate TypeScript Types | |
| run: npm run validate-types | |
| # Build and test against supported versions of React, Node and SVG Core. | |
| build-and-test: | |
| runs-on: ubuntu-latest | |
| needs: validate | |
| strategy: | |
| matrix: | |
| free-solid-svg-icons: [7.x, 6.x] | |
| fontawesome-svg-core: [7.x, 6.x] | |
| node-version: [24.x, 22.x, 20.x] | |
| react: [19.x, 18.x] | |
| exclude: | |
| # For v7.x core, allow all icon versions | |
| # For v6.x exclude v7.x icons | |
| - free-solid-svg-icons: '7.x' | |
| fontawesome-svg-core: '6.x' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: 'npm' | |
| - name: Install base dependencies | |
| run: npm ci | |
| - name: Install React dependencies | |
| run: npm ci --no-save react@${{ matrix.react }} react-dom@${{ matrix.react }} | |
| - name: Install FontAwesome dependencies | |
| run: npm ci --no-save @fortawesome/fontawesome-svg-core@${{ matrix.fontawesome-svg-core }} @fortawesome/free-solid-svg-icons@${{ matrix.free-solid-svg-icons }} | |
| - name: Verify React version | |
| run: npm list react react-dom | |
| - name: Test | |
| run: npm run test | |
| env: | |
| CI: true | |
| - name: Build | |
| run: npm run build |