1
0
mirror of synced 2025-12-23 21:03:15 -05:00

update docs to avoid long run times for formatting (#7064)

This commit is contained in:
Charles
2021-10-15 13:04:42 -07:00
committed by GitHub
parent 713fe61efd
commit d154f8b278
2 changed files with 14 additions and 5 deletions

View File

@@ -8,7 +8,6 @@ The following technologies are required to build Airbyte locally.
4. `Docker`
5. `Postgresql`
6. `Jq`
7. `CMake`
{% hint style="info" %}
Manually switching between different language versions can get hairy. We recommend using a version manager such as [`pyenv`](https://github.com/pyenv/pyenv) or [`jenv`](https://github.com/jenv/jenv).
@@ -57,6 +56,7 @@ export CPPFLAGS="-I/usr/local/opt/openssl/include"
## Run in `dev` mode with `docker-compose`
These instructions explain how to run a version of Airbyte that you are developing on (e.g. has not been released yet).
```bash
SUB_BUILD=PLATFORM ./gradlew build
VERSION=dev docker-compose up
@@ -78,7 +78,17 @@ SUB_BUILD=PLATFORM ./gradlew :airbyte-tests:acceptanceTests
## Run formatting automation/tests
To format code in the repo, simply run `./gradlew format` at the base of the repo.
Airbyte runs a code formatter as part of the build to enforce code styles. You should run the formatter yourself before submitting a PR (otherwise the build will fail).
The command to run formatting varies slightly depending on which part of the codebase you are working in.
### Platform
If you are working in the platform run `SUB_BUILD=PLATFORM ./gradlew format` from the root of the repo.
### Connector
If you are working on an individual connectors run: `./gradlew :airbyte-integrations:<directory the connector is in e.g. source-postgres>:format`.
### Connector Infrastructure
Finally, if you are working in any module in `:airbyte-integrations:bases` or `:airbyte-cdk:python`, run `SUB_BUILD=CONNECTORS_BASE ./gradlew format`.
Note: If you are contributing a Python file without imports or function definitions, place the following comment at the top of your file: