| Hendrik Hofstadt | 0d7c91e | 2019-10-23 21:44:47 +0200 | [diff] [blame] | 1 | # Nexantic monorepo |
| Leopold Schabel | 67f9d09 | 2019-10-22 15:41:42 +0200 | [diff] [blame] | 2 | |
| Hendrik Hofstadt | 0d7c91e | 2019-10-23 21:44:47 +0200 | [diff] [blame] | 3 | This is the monorepo storing all of nexantic's internal projects and libraries. |
| Leopold Schabel | 67f9d09 | 2019-10-22 15:41:42 +0200 | [diff] [blame] | 4 | |
| Hendrik Hofstadt | 0d7c91e | 2019-10-23 21:44:47 +0200 | [diff] [blame] | 5 | ## Environment |
| Leopold Schabel | 5c80aca | 2019-10-22 15:48:58 +0200 | [diff] [blame] | 6 | |
| Leopold Schabel | 8b9c055 | 2019-11-15 14:07:45 +0100 | [diff] [blame] | 7 | We assume a Fedora 30 or 31 host system provisioned using rW, and IntelliJ as the IDE. |
| Leopold Schabel | 67f9d09 | 2019-10-22 15:41:42 +0200 | [diff] [blame] | 8 | |
| Leopold Schabel | 8b9c055 | 2019-11-15 14:07:45 +0100 | [diff] [blame] | 9 | For better reproducibility, all builds are executed in containers. |
| Leopold Schabel | 67f9d09 | 2019-10-22 15:41:42 +0200 | [diff] [blame] | 10 | |
| Hendrik Hofstadt | 0d7c91e | 2019-10-23 21:44:47 +0200 | [diff] [blame] | 11 | #### Usage |
| Leopold Schabel | 5c80aca | 2019-10-22 15:48:58 +0200 | [diff] [blame] | 12 | |
| Hendrik Hofstadt | 0d7c91e | 2019-10-23 21:44:47 +0200 | [diff] [blame] | 13 | Spinning up: `scripts/create_container.sh` |
| Leopold Schabel | 5c80aca | 2019-10-22 15:48:58 +0200 | [diff] [blame] | 14 | |
| Hendrik Hofstadt | 0d7c91e | 2019-10-23 21:44:47 +0200 | [diff] [blame] | 15 | Spinning down: `scripts/destroy_container.sh` |
| 16 | |
| Leopold Schabel | 8b9c055 | 2019-11-15 14:07:45 +0100 | [diff] [blame] | 17 | Running commands: `scripts/run_in_container.sh <...>` |
| Hendrik Hofstadt | 0d7c91e | 2019-10-23 21:44:47 +0200 | [diff] [blame] | 18 | |
| Leopold Schabel | 8b9c055 | 2019-11-15 14:07:45 +0100 | [diff] [blame] | 19 | Using bazel using a wrapper script: `scripts/bin/bazel <...>` (add to your local $PATH for convenience) |
| Hendrik Hofstadt | 0d7c91e | 2019-10-23 21:44:47 +0200 | [diff] [blame] | 20 | |
| Leopold Schabel | 8b9c055 | 2019-11-15 14:07:45 +0100 | [diff] [blame] | 21 | #### IntelliJ |
| 22 | |
| 23 | This repository is compatible with the IntelliJ Bazel plugin. All commands run inside the container, and |
| 24 | necessary paths are mapped into the container. |
| 25 | |
| 26 | We check the entire .ijwb project directory into the repository, which requires everyone to use the latest |
| 27 | version of both IntelliJ and the Bazel plugin, but eliminates manual setup steps. |
| 28 | |
| 29 | The following steps are necessary: |
| 30 | |
| 31 | - Install Google's official Bazel plugin in IntelliJ. |
| 32 | |
| 33 | - Add the absolute path to your ~/.cache/bazel-nxt folder to your idea64.vmoptions (Help → Edit Custom VM Options) |
| 34 | and restart IntelliJ: |
| 35 | |
| 36 | `-Dbazel.bep.path=/home/leopold/.cache/bazel-nxt` |
| 37 | |
| 38 | - Set "*Bazel Binary Location*" in Other Settings → Bazel Settings to the absolute path of scripts/bin/bazel. |
| 39 | This is a wrapper that will execute Bazel inside the container. |
| 40 | |
| 41 | - Open the `.ijwb` folder as IntelliJ project. |
| 42 | |
| 43 | - Disable Vgo support for the project. |
| 44 | |
| 45 | - Run a non-incremental sync in IntelliJ |
| 46 | |
| 47 | The plugin will automatically resolve paths for generated files. |
| 48 | |
| 49 | If you do not use IntelliJ, you need to use the scripts/bazel_copy_generated_for_ide.sh script to copy files locally. |