klesh opened a new pull request, #837:
URL: https://github.com/apache/devlake-website/pull/837

   ### Summary
   
   Documents the packaging change tracked in apache/devlake#9276: DevLake ships 
as one `lake` binary containing the framework, the API and every official 
plugin, and a deployed binary still loads extra `.so` plugins from `PLUGIN_DIR`.
   
   Two files:
   
   - **`docs/DeveloperManuals/DeveloperSetup.md`** — the "Compiling" section 
was indented four spaces, so it rendered as a code block, and it documented two 
things that do not exist: `PLUGIN=<name>` (the variable is `DEVLAKE_PLUGINS`) 
and `make build-worker`. Rewritten for the single-binary default, with the 
`DEVLAKE_PLUGINS` subset and `make build-plugin` paths. A new "Sideloading 
plugins" section explains where the `.so` files go, why they must be built with 
the matching toolchain, and that a plugin that fails to load is skipped instead 
of taking the server down.
   - **`docs/GettingStarted/Environment.md`** — new `PLUGIN_DIR` entry: default 
value, the container mount path (`/app/bin/plugins`), the skip-on-failure 
behaviour and the override warning.
   
   ### Dependency (do not merge yet)
   
   This describes behaviour that is **not on `devlake` `main` yet**:
   
   - apache/devlake#9288 adds the compile-time registry and the hardened 
sideload loader, and is still open.
   - The build/packaging switch (`make build` producing one binary, the 
Dockerfile dropping `/app/bin/plugins`) has not been written yet.
   
   Merge this once that packaging PR lands, otherwise the docs describe 
commands the released binaries do not have yet. Keeping it open also lets the 
packaging PR correct any detail here.
   
   ### Does this close any open issues?
   
   Refs apache/devlake#9276.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to