Skip to content

Commit

Permalink
orb(react-native-mlkit): chore: add ci:trust script to allow us to ru…
Browse files Browse the repository at this point in the history
…n ci pipeline on forks (#148 by @trevor-coleman) (78f30eb3b9fcb51a366968a879d0758d2b1d5e8f)
  • Loading branch information
infinitered-circleci committed Jun 7, 2024
1 parent 47db987 commit e6c89c2
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Running Tests on Untrusted Forks
sidebar_position: 99
---

# Running CI Scripts on Untrusted Forks

Untrusted forks could contain malicious code to mine cryptocurrency, steal secrets, or otherwise harm the CI server.

For PRs from untrusted forks, to run the CI scripts, we need to:

1. Review the code to ensure that it is safe to run on the CI server.
2. If the code is safe, run the `ci:trust` script to push the commits to a branch on the main repository, where the CI
scripts can be run.
3. Once the tests have run, the status of the PR will be updated automatically (because the commits are the same).

## How to run the CI scripts on untrusted forks:

1. Copy the name of the branch from the PR.
<img src="./images/ci-copy-fork-branch.png" alt="ci-copy-fork-branch" width="400"/>
2. From your local clone of the main repository, run the `ci:trust` script.
```bash
yarn ci:trust <branch-name>
```
3. The branch will be pushed and the tests will run
<img src="./images/ci-tests-running.png" alt="ci-tests-running" width="400"/>

## What does ci:trust do?

The `ci:trust` script does the following:

1. Adds and fetches the untrusted fork as a temporary remote in your local repository.
2. Pushes the specific branch from the untrusted fork to a designated temporary branch in your original repository.
3. Pushing to a local branch triggers the continuous integration (CI) tests on the commits of the branch.
4. Because the commits are the same, the status of the PR will be updated automatically.

### Notes

1. The ci:trust script will only work if you have write access to the main repository. This prevents malicious users
from running the script on the main repository.
2. The ci:trust script pushes the commits to a branch called `temp-branch-to-test-fork`.

::: warning

The `temp-branch-to-test-fork` branch will be deleted and recreated if it already exists. This allows the script to
clean up its own temporary branches.

:::

0 comments on commit e6c89c2

Please sign in to comment.