Document command to only build core Airbyte systems. #2351
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cgardens
approved these changes
Mar 8, 2021
sherifnada
reviewed
Mar 8, 2021
| @@ -38,6 +38,11 @@ This will build all the code and run all the unit tests. | |||
|
|
|||
| `./gradle build` creates all the necessary artifacts \(Webapp, Jars and Docker images\) so that you can run Airbyte locally. | |||
|
|
|||
| The `./gradlew build` builds the core Airbyte system, and all the connectors. This can take some time. To compile and build just the core systems: | |||
| ```bash | |||
| export CORE_ONLY=1 && ./gradlew build | |||
There was a problem hiding this comment.
wouldn't this set CORE_ONLY to true for every subsequent build command in this session too? is that the desired behavior?
There was a problem hiding this comment.
good catch. changing to CORE_ONLY=true && ./gradlew build
There was a problem hiding this comment.
I think you don't need the && , running CORE_ONLY=true ./gradlew build sets the env variable for that command only
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Since the full airbyte build takes some time, devs might want to save time and only build the core airbyte system. This functionality already exists, however is not documented anywhere.
Also take the chance to add the
outdirectories to the .gitignore file.How
Documenting it.
Pre-merge Checklist