chore: Converted CircleCi to Github workflows #4884
+145
−248
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,145 @@ | ||||||||
| name: build-and-test | ||||||||
|
|
||||||||
| on: | ||||||||
| push: | ||||||||
| branches: | ||||||||
| - main | ||||||||
| pull_request: | ||||||||
|
|
||||||||
| jobs: | ||||||||
| lint: | ||||||||
| runs-on: ubuntu-latest | ||||||||
| steps: | ||||||||
| - uses: actions/checkout@v4 | ||||||||
| - uses: actions/setup-node@v4 | ||||||||
| with: | ||||||||
| node-version: '20.19.0' | ||||||||
|
Collaborator
There was a problem hiding this comment. can we extract node version to env var? or use version from |
||||||||
| cache: 'yarn' | ||||||||
| - run: corepack enable | ||||||||
| - run: yarn --immutable | ||||||||
| - run: yarn lint-no-fix | ||||||||
|
|
||||||||
| typescript: | ||||||||
| runs-on: ubuntu-latest | ||||||||
| steps: | ||||||||
| - uses: actions/checkout@v4 | ||||||||
| - uses: actions/setup-node@v4 | ||||||||
| with: | ||||||||
| node-version: '20.19.0' | ||||||||
| cache: 'yarn' | ||||||||
| - run: corepack enable | ||||||||
| - run: yarn --immutable | ||||||||
| - run: yarn typescript | ||||||||
|
|
||||||||
| unit-tests: | ||||||||
| runs-on: ubuntu-latest | ||||||||
| steps: | ||||||||
| - uses: actions/checkout@v4 | ||||||||
|
Collaborator
There was a problem hiding this comment. I didn't count, but looks like all jobs use the same steps (checkout, setup node, install deps...). Let's create a composite action with steps that we need to setup everything before we run a job. |
||||||||
| - uses: actions/setup-node@v4 | ||||||||
| with: | ||||||||
| node-version: '20.19.0' | ||||||||
| cache: 'yarn' | ||||||||
| - run: corepack enable | ||||||||
| - run: yarn --immutable | ||||||||
| - uses: actions/cache@v4 | ||||||||
| with: | ||||||||
| path: ./cache/jest | ||||||||
| key: jest-cache-${{ github.ref_name }} | ||||||||
| restore-keys: jest-cache- | ||||||||
| - name: Run unit tests | ||||||||
| run: yarn test --maxWorkers=2 --coverage | ||||||||
| - uses: actions/upload-artifact@v4 | ||||||||
| if: always() | ||||||||
| with: | ||||||||
| name: coverage | ||||||||
| path: coverage | ||||||||
|
|
||||||||
| build-package: | ||||||||
| runs-on: ubuntu-latest | ||||||||
| steps: | ||||||||
| - uses: actions/checkout@v4 | ||||||||
| - uses: actions/setup-node@v4 | ||||||||
| with: | ||||||||
| node-version: '20.19.0' | ||||||||
| cache: 'yarn' | ||||||||
| - run: corepack enable | ||||||||
| - run: yarn --immutable | ||||||||
| - name: Build package | ||||||||
| run: | | ||||||||
| yarn prepack | ||||||||
| node ./scripts/typescript-output-lint | ||||||||
| build-docs: | ||||||||
| if: github.ref != 'refs/heads/main' | ||||||||
| runs-on: ubuntu-latest | ||||||||
| steps: | ||||||||
| - uses: actions/checkout@v4 | ||||||||
| - uses: actions/setup-node@v4 | ||||||||
| with: | ||||||||
| node-version: '20.19.0' | ||||||||
| cache: 'yarn' | ||||||||
| - run: corepack enable | ||||||||
| - run: yarn --immutable | ||||||||
| - name: Build docs | ||||||||
| run: yarn --cwd docs build | ||||||||
| - uses: actions/upload-artifact@v4 | ||||||||
| with: | ||||||||
| name: docs | ||||||||
| path: docs/build | ||||||||
|
|
||||||||
| comment-artifacts: | ||||||||
| if: github.event_name == 'pull_request' | ||||||||
| needs: build-docs | ||||||||
| runs-on: ubuntu-latest | ||||||||
| permissions: | ||||||||
| pull-requests: write | ||||||||
| steps: | ||||||||
| - uses: actions/github-script@v7 | ||||||||
| with: | ||||||||
| script: | | ||||||||
| const artifactsUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}/artifacts`; | ||||||||
| const body = `Hey @${context.payload.pull_request.user.login}, thank you for your pull request 🤗. The documentation from this branch can be viewed [here](${artifactsUrl}).`; | ||||||||
| const marker = 'The documentation from this branch can be viewed'; | ||||||||
| const { data: comments } = await github.rest.issues.listComments({ | ||||||||
| owner: context.repo.owner, | ||||||||
| repo: context.repo.repo, | ||||||||
| issue_number: context.issue.number, | ||||||||
| }); | ||||||||
| const existing = comments.find(c => c.body.includes(marker)); | ||||||||
| if (existing) { | ||||||||
| await github.rest.issues.updateComment({ | ||||||||
| owner: context.repo.owner, | ||||||||
| repo: context.repo.repo, | ||||||||
| comment_id: existing.id, | ||||||||
| body, | ||||||||
| }); | ||||||||
| } else { | ||||||||
| await github.rest.issues.createComment({ | ||||||||
| owner: context.repo.owner, | ||||||||
| repo: context.repo.repo, | ||||||||
| issue_number: context.issue.number, | ||||||||
| body, | ||||||||
| }); | ||||||||
| } | ||||||||
| deploy-docs: | ||||||||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||||||||
|
Collaborator
There was a problem hiding this comment. deploy-docs runs even if checks fail. I'd run it when all steps pass
Suggested change
|
||||||||
| runs-on: ubuntu-latest | ||||||||
| steps: | ||||||||
| - uses: actions/checkout@v4 | ||||||||
| - uses: actions/setup-node@v4 | ||||||||
| with: | ||||||||
| node-version: '20.19.0' | ||||||||
| cache: 'yarn' | ||||||||
| - run: corepack enable | ||||||||
| - run: yarn --immutable | ||||||||
| - name: Build docs | ||||||||
| run: yarn --cwd docs build | ||||||||
| - name: Deploy to GitHub Pages | ||||||||
| uses: peaceiris/actions-gh-pages@v4 | ||||||||
| with: | ||||||||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||||||||
| publish_dir: ./docs/build | ||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about defining concurrency rules to limit runs on frequent pushes?