Skip to content

Commit 7df828e

Browse files
Merge pull request circleci#4501 from circleci/OSS-Updated-063020
Update oss.md
2 parents 4ebb651 + 85f2d6d commit 7df828e

File tree

1 file changed

+19
-43
lines changed

1 file changed

+19
-43
lines changed

jekyll/_cci2/oss.md

+19-43
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,14 @@ for building your open source project on CircleCI in the following sections:
1919
To support the open source community, organizations on Github or Bitbucket will be given 100,000 free credits per week that can be spent on open source projects. These credits can be spent on Linux-medium resources. Each organization can have a maximum of four concurrent jobs running.
2020

2121
**Note:**
22-
If you are building an open source project on macOS,
23-
contact billing@circleci.com to enable these additional containers.
22+
If you are building an open source project on macOS, contact billing@circleci.com to enable these additional containers.
2423

2524
## Security
2625

27-
While open source can be a liberating practice,
28-
take care not to liberate sensitive information.
26+
While open source can be a liberating practice, take care not to liberate sensitive information.
2927

30-
- If your repository is public,
31-
your CircleCI project and its build logs are also public.
32-
Pay attention to the information you choose to print.
33-
- Environment variables set in the CircleCI application are hidden from the public,
34-
these variables will not be shared in [forked PRs](#pass-secrets-to-builds-from-forked-pull-requests)
28+
- If your repository is public, your CircleCI project and its build logs are also public. Pay attention to the information you choose to print.
29+
- Environment variables set in the CircleCI application are hidden from the public, these variables will not be shared in [forked PRs](#pass-secrets-to-builds-from-forked-pull-requests)
3530
unless explicitly enabled.
3631

3732
## Features and Settings for Open Source Projects
@@ -41,49 +36,34 @@ The following features and settings are especially useful for open source projec
4136
### Private Environment Variables
4237
{:.no_toc}
4338

44-
Many projects require API tokens, SSH keys, or passwords.
45-
Private environment variables allow you
46-
to safely store secrets,
47-
even if your project is public.
48-
For more information,
49-
see the [Environment Variables]({{ site.baseurl }}/2.0/env-vars/#setting-an-environment-variable-in-a-project) document.
39+
Many projects require API tokens, SSH keys, or passwords. Private environment variables allow you to safely store secrets, even if your project is public.
40+
41+
For more information, see the [Environment Variables]({{ site.baseurl }}/2.0/env-vars/#setting-an-environment-variable-in-a-project) document.
5042

5143
### Only Build Pull Requests
5244
{:.no_toc}
5345

54-
By default, CircleCI builds every commit from every branch.
55-
This behavior may be too aggressive for open source projects,
56-
which often have significantly more commits than private projects.
57-
To change this setting,
58-
go to the **Advanced Settings** of your project
59-
and set the **Only build pull requests** option to _On_.
46+
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.
6047

61-
**Note:**
62-
Even if this option is enabled,
63-
CircleCI will still build all commits from your project's default branch.
48+
To change this setting, go to the **Project Settings>Advanced** of your project and set the **Only build pull requests** option to _On_.
49+
50+
**Note:** Even if this option is enabled, CircleCI will still build all commits from your project's default branch.
6451

6552
### Build Pull Requests From Forked Repositories
6653
{:.no_toc}
6754

68-
Many open source projects accept PRs from forked repositories.
69-
Building these PRs is an effective way
70-
to catch bugs before manually reviewing changes.
55+
Many open source projects accept PRs from forked repositories. Building these PRs is an effective way to catch bugs before manually reviewing changes.
56+
57+
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_.
7158

72-
By default, CircleCI does not build PRs from forked repositories.
73-
To change this setting,
74-
go to the **Advanced Settings** of your project
75-
and set the **Build forked pull requests** option to _On_.
59+
**Note:** 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.
7660

7761
### Pass Secrets to Builds From Forked Pull Requests
7862
{:.no_toc}
7963

80-
Running an unrestricted build in a parent repository can be dangerous.
81-
Projects often contain sensitive information,
82-
and this information is freely available to anyone
83-
who can push code that triggers a build.
64+
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.
8465

85-
By default, CircleCI does not pass secrets to builds from forked PRs for open source projects
86-
and hides four types of configuration data:
66+
By default, CircleCI does not pass secrets to builds from forked PRs for open source projects and hides four types of configuration data:
8767

8868
- [Environment variables](#private-environment-variables) set through the application.
8969

@@ -95,13 +75,9 @@ to access arbitrary hosts during a build.
9575
- [AWS permissions]({{ site.baseurl }}/2.0/deployment-examples/#aws) and configuration files.
9676

9777
**Note:**
98-
Forked PR builds of open source projects that require secrets
99-
will not run successfully on CircleCI until you enable this setting.
78+
Forked PR builds of open source projects that require secrets will not run successfully on CircleCI until you enable this setting.
10079

101-
If you are comfortable sharing secrets with anyone who forks your project and opens a PR,
102-
you can enable the **Pass secrets to builds from forked pull requests** option.
103-
In the **Advanced Settings** of your project,
104-
set the **Pass secrets to builds from forked pull requests** option to _On_.
80+
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_.
10581

10682
### Caching
10783

0 commit comments

Comments
 (0)