docs: update README to include features section #31
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: quality checks | |
| on: | |
| # manual | |
| workflow_dispatch: | |
| # pull_request: | |
| # this will inclue secrets of the repo in pull requests | |
| pull_request_target: | |
| branches: | |
| - master | |
| push: | |
| branches: | |
| - master | |
| paths: | |
| - src/**.ts | |
| - package.json | |
| - tsconfig.json | |
| - .github/workflows/**.yml | |
| jobs: | |
| checks: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: ".nvmrc" | |
| - run: | | |
| cat <<EOF >> .env | |
| ACCESSKEY_ID=${{ secrets.ACCESSKEY_ID }} | |
| SECRET_ACCESS_KEY=${{ secrets.SECRET_ACCESS_KEY }} | |
| EOF | |
| cat .env | |
| - name: install dependencies | |
| run: | | |
| npm install --silent | |
| - name: typecheck | |
| run: | | |
| npm run typecheck | |
| - name: test | |
| run: | | |
| npm test | |
| fmt: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: ".nvmrc" | |
| - run: | | |
| npm install --silent | |
| npm run fmt:check |