digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-19 16:57:40 +03:00
Code Issues Projects Releases Wiki Activity

Docker Hub description for digitalasset/daml-sdk (#7886)

Browse Source 
This commit just copies the existing description of the image from
DockerHub so we have a starting point to change it.

CHANGELOG_BEGIN
CHANGELOG_END
This commit is contained in:
Gary Verhaegen 2020-11-04 18:25:08 +01:00 committed by GitHub
parent ad541bebce
commit ba2ce20bb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
ci/docker/README.md Normal file
View File

@ -0,0 +1,38 @@
<!--
This file is meant to be displayed as the description of the
digitalasset/daml-sdk image on Docker Hub. Unfortunately, updating that is a
manual process at the moment. This README is the source of truth and should
overwrite the one on Docker Hub should they differ.
-->
# Dockerized DAML SDK
Digital Asset's [DAML SDK](https://docs.daml.com/) in a can
## Tags
* `${SDK_VERSION}` (_Alpine Linux_)
## Quick start
* Ensure Docker is [installed](https://www.docker.com/get-started)
* Check out existing demo DAML project (or use your own):
```
git clone https://github.com/digital-asset/ex-bond-trading.git
cd ex-bond-trading
```
* Run DAML scenarios:
```
docker run --rm -it -v $PWD:/data digitalasset/daml-sdk:${SDK_VERSION} bash -c "~/.daml/bin/daml test --files /data/src/main/daml/Test.daml"
```
> Note: This image is primarily intended for CI workflows, where the benefits of caching Docker images can outweigh the awkwardness of the above command. For local development, we strongly recommend installing the DAML SDK on the host development machine instead, by running `curl https://get.daml.com | bash`.
## License
View [license information](https://www.apache.org/licenses/LICENSE-2.0) for the software contained in this image.
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.