Skip to content

Commit 6c92fec

Browse files
authored
Add a note about running only in dev mode on M1 (#10772)
Macs with M1 chip can run Airbyte only in dev mode right now, so to make it clear, I added a note about it and moved the hint about M1 chips to the top of the section.
1 parent a8f7365 commit 6c92fec

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

docs/contributing-to-airbyte/developing-locally.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,29 +27,27 @@ To start contributing:
2727

2828
## Build with `gradle`
2929

30-
To compile and build just the platform \(not all the connectors\):
31-
32-
```bash
33-
SUB_BUILD=PLATFORM ./gradlew build
34-
```
35-
3630
{% hint style="info" %}
37-
If you're using Mac M1 \(Apple Silicon\) machines, it is possible to compile Airbyte by setting
38-
some additional environment variables:
31+
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:
3932

4033
```bash
4134
export DOCKER_BUILD_PLATFORM=linux/arm64
4235
export DOCKER_BUILD_ARCH=arm64
4336
export ALPINE_IMAGE=arm64v8/alpine:3.14
4437
export POSTGRES_IMAGE=arm64v8/postgres:13-alpine
4538
export JDK_VERSION=17
46-
SUB_BUILD=PLATFORM ./gradlew build
4739
```
4840

4941
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.
5042

5143
{% endhint %}
5244

45+
To compile and build just the platform \(not all the connectors\):
46+
47+
```bash
48+
SUB_BUILD=PLATFORM ./gradlew build
49+
```
50+
5351
This will build all the code and run all the unit tests.
5452

5553
`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.

0 commit comments

Comments
 (0)