Building Open Source Projects
On This Page
This document provides tips and best practices for building your open source project on CircleCI.
To support the open source community, organizations on Github or Bitbucket will be given free credits every week that can be spent on open source projects. These credits can be spent on Linux resources.
- If you are building an open source project on macOS, contact email@example.com to enable these additional containers.
- Open-source credit availability and limits will not be visible in the UI.
While open source can be a liberating practice, take care not to liberate sensitive information.
- If your repository is public, your CircleCI project and its build logs are also public. Pay attention to the information you choose to print.
- Environment variables set in the CircleCI application are hidden from the public, these variables will not be shared in forked PRs unless explicitly enabled.
Features and settings for open source projects
The following features and settings are especially useful for open source projects.
Private environment variables
Many projects require API tokens, SSH keys, or passwords. Private environment variables allow you to safely store secrets, even if your project is public.
For more information, see the Set an environment variable document.
Only build pull requests
By default, CircleCI builds every commit from every branch. This behavior may be too aggressive for open source projects, which often have significantly more commits than private projects.
To change this setting, go to the Project Settings>Advanced of your project and set the Only build pull requests option to On.
The ability to override the “Only Build Pull Requests” setting is also supported. Specifically, CircleCI will run validation on all commits from additional, non-default branches that are specified via regular expression (ie. “release.*”).
Currently, the only way to override the “Only Build Pull Requests” setting is to open a support request at https://support.circleci.com/. In the request, please specify the regular expression(s) that you would like to add to the “allow-list” of branches for which CircleCI will validate every commit. You must also submit a support request to remove or edit the regular expressions that are applied to your organization. See more details on our ideas forum.
Build pull requests from forked repositories
Many open source projects accept PRs from forked repositories. Building these PRs is an effective way to catch bugs before manually reviewing changes.
By default, CircleCI does not build PRs from forked repositories. To change this setting, go to the Project Settings > Advanced of your project and set the Build forked pull requests option to On.
If a user submits a pull request to your repository from a fork, but no pipeline is triggered, then the user most likely is following a project fork on their personal account rather than the project itself of CircleCI, causing the jobs to trigger under the user’s personal account and not the organization account. To resolve this issue, have the user unfollow their fork of the project on CircleCI and instead follow the source project. This will trigger their jobs to run under the organization when they submit pull requests.
Pass secrets to builds from forked pull requests
Running an unrestricted build in a parent repository can be dangerous. Projects often contain sensitive information, and this information is freely available to anyone who can push code that triggers a build.
By default, CircleCI does not pass secrets to builds from forked PRs for open source projects and hides four types of configuration data:
Environment variables set through the application.
Passphraseless private SSH keys you have added to CircleCI to access arbitrary hosts during a build.
AWS permissions and configuration files.
Forked PR builds of open source projects that require secrets will not run successfully on CircleCI until you enable this setting.
If you are comfortable sharing secrets with anyone who forks your project and opens a PR, you can enable the Pass secrets to builds from forked pull requests option. In the Project Settings>Advanced of your project, set the Pass secrets to builds from forked pull requests option to On.
Caches are isolated based on GitHub Repo for PRs. CircleCI uses the GitHub repository-id of the originator of the fork PR to identify the cache.
- PRs from the same fork repo will share a cache. For example, PRs from the main repo share a cache with the main repo branches (in particular the
- Two PRs in different fork repos will have different caches. That means that a PR from a fork will not share a cache with the main repo
- enabling the passing of secrets to build from forked pull requests will enable cache sharing between the original repo and all forked builds.
Currently there is no pre-population of caches because this optimization has not made it to the top of the priority list yet.
Example open source projects
Following are a few examples of projects (big and small) that build on CircleCI:
- Storybook - Interactive UI component dev & test: React, React Native, Vue, Angular, Ember.
- Angular - Framework for building browser and desktop web applications.
- Apollo - A community building flexible open source tools for GraphQL.
- PyTorch - Data manipulation and Machine Learning platform.
- Calypso - The next generation webapp powering WordPress.com.
- Fastlane - A build automatically tool for Android and iOS.
- Yarn - The npm replacement.
Refer to the Examples document for more public and open source project configuration links organized by CircleCI features and by programming language.
Help make this document better
This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.
- Suggest an edit to this page (please read the contributing guidefirst).
- To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
- CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.
Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.
You can also visit our support site to find support articles, community forums, and training resources.
CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.