docs: restructure repo docs around the npm package #9
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: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| concurrency: | |
| group: ci-${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| verify: | |
| if: github.event_name != 'push' || !contains(github.event.head_commit.message, '[skip ci]') | |
| name: Verify workspace | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Vite+ | |
| uses: voidzero-dev/setup-vp@v1 | |
| with: | |
| node-version-file: ".node-version" | |
| cache: true | |
| - name: Install dependencies | |
| run: vp install | |
| - name: Verify library | |
| working-directory: packages/react-json-logic | |
| run: vp run verify | |
| - name: Verify example app | |
| working-directory: apps/example | |
| run: vp run verify | |
| # Release job is staged but DISABLED until we're ready to ship to npm. | |
| # When ready, flip the `if:` predicate below to: | |
| # github.event_name == 'push' && github.ref == 'refs/heads/main' && !contains(github.event.head_commit.message, '[skip ci]') | |
| # The supporting config (`packages/react-json-logic/.releaserc.json`, | |
| # `publishConfig.provenance: true`, `NPM_TOKEN` secret) is already in place. | |
| release: | |
| if: false | |
| name: Release react-json-logic | |
| needs: | |
| - verify | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| permissions: | |
| contents: write | |
| issues: write | |
| pull-requests: write | |
| steps: | |
| - name: Check out repository | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Vite+ | |
| uses: voidzero-dev/setup-vp@v1 | |
| with: | |
| node-version-file: ".node-version" | |
| cache: true | |
| - name: Install dependencies | |
| run: vp install | |
| - name: Build library | |
| working-directory: packages/react-json-logic | |
| run: vp pack | |
| - name: Release package | |
| uses: cycjimmy/semantic-release-action@v6 | |
| with: | |
| working_directory: packages/react-json-logic | |
| extra_plugins: | | |
| @semantic-release/commit-analyzer | |
| @semantic-release/release-notes-generator | |
| @semantic-release/npm | |
| @semantic-release/github | |
| @semantic-release/git | |
| conventional-changelog-conventionalcommits | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| NPM_TOKEN: ${{ secrets.NPM_TOKEN }} | |
| GIT_AUTHOR_NAME: glitch418x | |
| GIT_AUTHOR_EMAIL: 189487110+glitch418x@users.noreply.github.com | |
| GIT_COMMITTER_NAME: glitch418x | |
| GIT_COMMITTER_EMAIL: 189487110+glitch418x@users.noreply.github.com |