Skip to content

Commit

Permalink
docs: add PR Voyager vs CodeSandbox CI section
Browse files Browse the repository at this point in the history
  • Loading branch information
kotarella1110 committed Aug 8, 2023
1 parent 7d63dc2 commit 33879a4
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,24 @@ For instance, if you want to manually create the `.npmrc` file before running th
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
```

## PR Voyager vs CodeSandbox CI

PR Voyager and [CodeSandbox CI](https://codesandbox.io/docs/learn/sandboxes/ci) are both GitHub-based services designed to assist with the development and testing of npm packages. However, they have several important differences that set them apart.

### PR Voyager

- GitHub Action: PR Voyager is a GitHub Action, automating the package build, test, and publishing processes within GitHub workflows.
- Support for Public and Private Repositories: PR Voyager supports both public and private repositories.
- Flexible Workflow: As a GitHub Action, PR Voyager offers users the freedom to tailor their workflows, providing flexibility for customizing package manager versions and build steps.

### CodeSandbox CI

- GitHub App: CodeSandbox CI is a GitHub App, simplifying setup and integration within repositories.
- Support for Public Repositories only: CodeSandbox CI supports public repositories only. Note that it may not be available for private repositories.
- Simplified Configuration: Utilizing a configuration file named .codesandbox/ci.json, CodeSandbox CI is straightforward to set up. However, it lacks the ability to specify package manager versions, limiting its adaptability.
- Integration with CodeSandbox: CodeSandbox CI makes it easy to test changes within CodeSandbox, allowing for immediate verification of modifications.

### Conclusion

PR Voyager and CodeSandbox CI each provide distinct approaches for building and testing packages within GitHub repositories. While PR Voyager offers support for both public and private repositories and provides extensive customization, CodeSandbox CI is tailored primarily for public repositories and offers seamless integration with CodeSandbox. Choose the tool that best suits your project's needs and build an effective development process.

0 comments on commit 33879a4

Please sign in to comment.