docs: update README #184
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: Code Quality Check & Publish | |
| on: | |
| push: | |
| branches: [main, beta, alpha, experimental] | |
| pull_request: | |
| types: [opened, synchronize] | |
| jobs: | |
| lint: | |
| name: ESLint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| - name: Install dependencies | |
| uses: bahmutov/npm-install@v1 | |
| - name: Lint files | |
| run: yarn lint | |
| type-check: | |
| name: Type check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| - name: Install dependencies | |
| uses: bahmutov/npm-install@v1 | |
| - name: Perform type checking | |
| run: yarn lint:types | |
| test: | |
| name: Unit test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| - name: Install dependencies | |
| uses: bahmutov/npm-install@v1 | |
| - name: Perform unit test | |
| run: yarn test | |
| publish: | |
| name: Publish to NPM | |
| needs: [lint, type-check, test] | |
| if: | | |
| github.repository == 'afiiif/floppy-disk' | |
| && (github.ref == 'refs/heads/main' | |
| || github.ref == 'refs/heads/beta' | |
| || github.ref == 'refs/heads/alpha' | |
| || github.ref == 'refs/heads/experimental') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| - name: Install dependencies | |
| uses: bahmutov/npm-install@v1 | |
| - name: Update package.json | |
| run: | | |
| npm pkg delete 'engines' | |
| npm pkg delete 'devDependencies' | |
| - name: Build package | |
| run: | | |
| if [ "${{ github.ref }}" = "refs/heads/experimental" ]; then | |
| PREACT=true yarn build | |
| else | |
| yarn build | |
| fi | |
| - name: Release package | |
| run: yarn semantic-release | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| NPM_TOKEN: ${{ secrets.NPM_TOKEN }} |