feat: build examples on ci #341
Conversation
WalkthroughThe changes in this pull request introduce a new step in the GitHub Actions CI workflow specifically for building examples. The new step, titled "Build examples," executes the command Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
.github/workflows/ci.yaml (2)
46-48: LGTM! The new step aligns with the PR objective.The addition of the "Build examples" step after package builds is a logical placement that will help catch breaking changes early.
Consider these improvements for robustness:
- name: Build examples - run: pnpm run build-examples + run: pnpm run build-examples + timeout-minutes: 10 + continue-on-error: false
Line range hint
1-48: Consider caching example build artifactsThe workflow has a good progression of steps, but could benefit from caching example build outputs to speed up subsequent runs.
Consider adding a cache step for example builds similar to how package builds might be cached. This would improve CI performance, especially for frequent updates to examples.
Example cache configuration:
- uses: actions/cache@v3 with: path: examples/**/dist key: ${{ runner.os }}-examples-${{ hashFiles('examples/**') }} restore-keys: | ${{ runner.os }}-examples-
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
.github/workflows/ci.yaml(1 hunks)
🔇 Additional comments (1)
.github/workflows/ci.yaml (1)
46-48: Verify the build-examples script exists
Let's ensure the referenced script is properly defined.
✅ Verification successful
Let me verify if the referenced build script exists.
The build-examples script is properly defined and configured
The verification confirms that:
- The
build-examplesscript is defined in the rootpackage.json - It points to
./scripts/build-examples.shwhich exists and contains proper build logic - The script is set up to build all example projects in the repository
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if build-examples script exists in package.json files
# Expected: Find at least one package.json with the build-examples script
# Search for package.json files and check their contents
fd package.json --type f --exec sh -c 'echo "=== Checking {}" && cat {} | jq -r "select(.scripts != null) | .scripts | select(.\"build-examples\" != null)"'
Length of output: 1667
Script:
#!/bin/bash
# Check if the build-examples.sh script exists and show its contents
fd build-examples.sh --type f --exec sh -c 'echo "=== Found script: {}" && cat {}'
Length of output: 805
Avoid merging that might break examples
Summary by CodeRabbit