Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.76 KB

DEVELOPING.md

File metadata and controls

49 lines (31 loc) · 1.76 KB

Developing LAMBKIN

Table of Contents

Environment

Most packages in LAMBKIN support development containers and docker compose-managed containers. This is also true for the entire repository. You may use the former through the vscode IDE or devcontainers CLI, or the latter with docker compose run. Either way, development container images must be built first. That is where earthly enters the scene.

For instance, to bring up the root development environment:

  1. Clone the repository. You will need git.

    git clone --recursive [email protected]:ekumenlabs/lambkin.git

  2. Setup development tools. You will need docker.

    cd lambkin
./tools/setup.sh

  3. Build the root development container.

    ./tools/earthly +local-ubuntu-devel

  4. Run the root development container. You may use devcontainers tooling or plain docker-compose:

    devcontainer --workspace-folder . up
    docker compose -f .devcontainer/docker-compose.yml run devcontainer

Workflow

As an heterogeneous collection of software packages, LAMBKIN does not usually afford single full builds. Every package will likely impose a workflow of its own, specially third-party ones. That said, colcon (plus extensions such as colcon-cmake, colcon-ros, and colcon-poetry-ros) will take you a long way.

Next Steps