| commit | dcfc6787c736ae3461138224a33c5d5c560df2ff | [log] [tgz] |
|---|---|---|
| author | Lorenz Brun <lorenz@monogon.tech> | Tue Nov 30 05:27:48 2021 +0100 |
| committer | Lorenz Brun <lorenz@monogon.tech> | Tue Nov 30 19:38:46 2021 +0000 |
| tree | 5ce2f2719c320e0f77aa5c667ed8221e27a39ca2 | |
| parent | 43e2107d9b76e8c1df0974c3125878ca64f2bb61 [diff] |
build/proto_docs: add proto documentation generator This adds an HTML documentation generator for our Protobuf files. It consists of a new Bazel rule `proto_docs` which wraps protoc-gen-doc. protoc-gen-doc itself and go-proto-validator which it includes need some light patching because of dumbness in the Go Proto ecosystem that doesn't exist in our Bazel build. This just hooks up everything, it does not yet do anything custom like annotating our own authorization metadata or similar. Change-Id: If6fd7c777210fea700e49242b5339cfafe7c030d Reviewed-on: https://review.monogon.dev/c/monogon/+/452 Reviewed-by: Leopold Schabel <leo@nexantic.com>
This is the main repository containing the source code for the Monogon Project.
This is pre-release software - feel free to look around, and check back later for our first release!
Our build environment requires a working Podman binary (your distribution should have one).
Spinning up: scripts/create_container.sh
Spinning down: scripts/destroy_container.sh
Running commands: scripts/run_in_container.sh <...>
Using bazel using a wrapper script: scripts/bin/bazel <...> (add to your local $PATH for convenience)
This repository is compatible with the IntelliJ Bazel plugin, which enables full autocompletion for external dependencies and generated code. All commands run inside the container, and necessary paths are mapped into the container.
The following steps are necessary:
Install Google's Bazel plugin in IntelliJ. On IntelliJ 2020.3 or later, you need to install a beta release of the plugin.
Add the absolute path to your ~/.cache/bazel-monogon folder to your idea64.vmoptions (Help → Edit Custom VM Options) and restart IntelliJ:
-Dbazel.bep.path=/home/leopold/.cache/bazel-monogon
Set "Bazel Binary Location" in Other Settings → Bazel Settings to the absolute path of scripts/bin/bazel. This is a wrapper that will execute Bazel inside the container.
Use File → Import Bazel project... to create a new project from .bazelproject.
After running the first sync, everything should now resolve in the IDE, including generated code.
Launch the node:
scripts/bin/bazel run //:launch
Run a kubectl command:
scripts/bin/bazel run //metropolis/cli/dbg -- kubectl describe
Run tests:
scripts/bin/bazel test //...