Skip to content

docs: Update package build instructions to use task command. #1394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 10, 2025
Merged

docs: Update package build instructions to use task command. #1394

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff670b3
Change task package to task; note that task corresponds to task docke…
quinntaylormitchell Oct 8, 2025
1356f26
Junhao comment
quinntaylormitchell Oct 9, 2025
ec3a063
Merge branch 'main' into feature branch
quinntaylormitchell Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions docs/src/dev-docs/building-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,16 @@ Both flavours contain the same binaries but are configured with different values
To build the package, run:

```shell
task package
task
```

The build will be in `build/clp-package` and defaults to using the storage engine for `clp-text`.

:::{note}
The `task` command runs `task docker-images:package` under the hood. In addition to the build, a
Docker image named `clp-package:dev-<user>-<unique-id>` will also be created.
:::

To build a releasable tar of either flavour, run:

```shell
Expand All @@ -75,16 +80,6 @@ To clean up all build artifacts, run:
task clean
```

## Building a Docker image

To build a Docker image containing the CLP package, run:

```shell
task docker-images:package
```

This will create a Docker image named `clp-package:dev`.

[Docker]: https://docs.docker.com/engine/install/
[Task]: https://taskfile.dev/
[uv]: https://docs.astral.sh/uv/
Expand Down