Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a note about running only in dev mode on M1 #10772

Merged
merged 1 commit into from
Mar 1, 2022
Merged

Add a note about running only in dev mode on M1 #10772

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions docs/contributing-to-airbyte/developing-locally.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,29 +27,27 @@ To start contributing:

## Build with `gradle`

To compile and build just the platform \(not all the connectors\):

```bash
SUB_BUILD=PLATFORM ./gradlew build
```

{% hint style="info" %}
If you're using Mac M1 \(Apple Silicon\) machines, it is possible to compile Airbyte by setting
some additional environment variables:
If you're using Mac M1 \(Apple Silicon\) machines, you can run Airbyte locally only in `dev` mode and you need to set these environment variables in order to build Airbyte:

```bash
export DOCKER_BUILD_PLATFORM=linux/arm64
export DOCKER_BUILD_ARCH=arm64
export ALPINE_IMAGE=arm64v8/alpine:3.14
export POSTGRES_IMAGE=arm64v8/postgres:13-alpine
export JDK_VERSION=17
SUB_BUILD=PLATFORM ./gradlew build
```

There are some known issues (Temporal failing during runs, and some connectors not working). See the [GitHub issue](https://github.com/airbytehq/airbyte/issues/2017) for more information.

{% endhint %}

To compile and build just the platform \(not all the connectors\):

```bash
SUB_BUILD=PLATFORM ./gradlew build
```

This will build all the code and run all the unit tests.

`SUB_BUILD=PLATFORM ./gradlew build` creates all the necessary artifacts \(Webapp, Jars and Docker images\) so that you can run Airbyte locally. Since this builds everything, it can take some time.
Expand Down