Skip to content

Commit dcc8a70

Browse files
committed
add docs
1 parent 912b678 commit dcc8a70

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,5 +69,16 @@ To clean up all build artifacts, run:
6969
task clean
7070
```
7171

72+
## Building a Docker image
73+
74+
To build a Docker image containing the CLP package, run:
75+
76+
```shell
77+
task docker-image-package
78+
```
79+
80+
This will create a Docker image named `clp-package-<os>-ubuntu-jammy:dev` where `<os>` is `x86` or
81+
`arm64`.
82+
7283
[clp-issue-872]: https://github.com/y-scope/clp/issues/872
7384
[Task]: https://taskfile.dev/

docs/src/dev-guide/tooling-containers.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,16 @@ environment.
133133
tools/docker-images/clp-execution-base-ubuntu-jammy
134134
```
135135

136+
## clp-package-x86-ubuntu-jammy
137+
138+
An image containing the CLP package built in an Ubuntu Jammy x86_64 environment.
139+
140+
* Path:
141+
142+
```text
143+
tools/docker-images/clp-package-ubuntu-jammy
144+
```
145+
136146
[core-deps-centos-stream-9]: https://github.com/y-scope/clp/pkgs/container/clp%2Fclp-core-dependencies-x86-centos-stream-9
137147
[core-deps-ubuntu-jammy]: https://github.com/y-scope/clp/pkgs/container/clp%2Fclp-core-dependencies-x86-ubuntu-jammy
138148
[core-ubuntu-jammy]: https://github.com/y-scope/clp/pkgs/container/clp%2Fclp-core-x86-ubuntu-jammy

docs/src/dev-guide/tooling-gh-workflows.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ This workflow builds CLP-core on macOS and runs its unit tests.
7676
This workflow builds a container image that contains the dependencies necessary to run the CLP
7777
package.
7878

79+
## clp-package-image-build
80+
81+
This workflow builds a container image that contains the CLP package.
82+
7983
## clp-lint
8084

8185
This workflow runs linting checks on the codebase.

0 commit comments

Comments
 (0)