docs: add readme in package and license #11
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: Check Docs | |
| on: | |
| schedule: | |
| # Run on the 1st of February, April, June, August, October, and December @ 00:00AM UTC-3 | |
| - cron: '0 3 1 FEB,APR,JUN,AUG,OCT,DEC *' | |
| push: | |
| branches: [main] | |
| pull_request: | |
| types: [ | |
| synchronize, # PR was updated | |
| opened, # PR was open | |
| reopened, # PR was closed and is now open again | |
| ready_for_review, # PR was converted from draft to open | |
| ] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| check_docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v4 | |
| - name: Setup node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version-file: '.nvmrc' | |
| cache: 'pnpm' | |
| - name: Install Dependencies | |
| run: pnpm install --frozen-lockfile --ignore-scripts | |
| - name: Check Docs | |
| run: pnpm check-docs |