Skip to content

Commit e42f2b9

Browse files
docs: Update package build instructions to use task command. (#1394)
1 parent 321aeee commit e42f2b9

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

docs/src/dev-docs/building-package.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,16 @@ Both flavours contain the same binaries but are configured with different values
5151
To build the package, run:
5252

5353
```shell
54-
task package
54+
task
5555
```
5656

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

59+
:::{note}
60+
The `task` command runs `task docker-images:package` under the hood. In addition to the build, a
61+
Docker image named `clp-package:dev-<user>-<unique-id>` will also be created.
62+
:::
63+
5964
To build a releasable tar of either flavour, run:
6065

6166
```shell
@@ -75,16 +80,6 @@ To clean up all build artifacts, run:
7580
task clean
7681
```
7782

78-
## Building a Docker image
79-
80-
To build a Docker image containing the CLP package, run:
81-
82-
```shell
83-
task docker-images:package
84-
```
85-
86-
This will create a Docker image named `clp-package:dev`.
87-
8883
[Docker]: https://docs.docker.com/engine/install/
8984
[Task]: https://taskfile.dev/
9085
[uv]: https://docs.astral.sh/uv/

0 commit comments

Comments
 (0)