kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

Merge pull request #1926 from gerhard/update-docs-to-0.2.4

Browse Source 
Update dagger version in all docs to 0.2.4
This commit is contained in:
Andrea Luzzardi
2022-03-29 11:48:38 -07:00
committed by GitHub
parent ece37623b2 4d7026895d
commit b32c8732bc
4 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/core-concepts/1202-plan.md
View File

@@ -82,7 +82,7 @@ The second import is for `netlify.#Deploy` to work.
:::info :::info
Which other imports we are missing? Which other imports we are missing?
Look at all the actions in the plan structure at the top of this page. Look at all the actions in the plan structure at the top of this page.
Now check all the available packages in [universe.dagger.io](https://github.com/dagger/dagger/tree/v0.2.3/pkg/universe.dagger.io). Now check all the available packages in [universe.dagger.io](https://github.com/dagger/dagger/tree/v0.2.4/pkg/universe.dagger.io).
::: :::
We now understand that the `deploy` action is the deploy definition from the netlify package, written as `deploy: netlify.#Deploy` We now understand that the `deploy` action is the deploy definition from the netlify package, written as `deploy: netlify.#Deploy`

66
docs/core-concepts/1213-dagger-cue.md
View File

@@ -5,7 +5,7 @@ displayed_sidebar: europa
# Dagger CUE API # Dagger CUE API
As of Dagger 0.2.0, the Dagger CUE API can be imported via `dagger.io/dagger` & `dagger.io/dagger/core` As of Dagger 0.2, the Dagger CUE API can be imported via `dagger.io/dagger` & `dagger.io/dagger/core`
The Dagger CUE API is the set of CUE packages released alongside the Dagger engine. The Dagger CUE API is the set of CUE packages released alongside the Dagger engine.
@@ -17,7 +17,7 @@ Developers of other Dagger packages are expected to build on top of these core p
| Definition | File | Description | | Definition | File | Description |
| :-- | :-- | :-- | | :-- | :-- | :-- |
| `#Plan` | [plan.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/plan.cue) | A special kind of program which `dagger` can execute | | `#Plan` | [plan.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/plan.cue) | A special kind of program which `dagger` can execute |
### Core types ### Core types
@@ -25,17 +25,17 @@ Dagger extends the CUE type system with the following core types:
| Definition | File | Description | | Definition | File | Description |
| :-- | :-- | :-- | | :-- | :-- | :-- |
| `#Address` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/types.cue) | Network service address | | `#Address` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/types.cue) | Network service address |
| `#CacheDir` | [exec.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/exec.cue) | A (best effort) persistent cache dir | | `#CacheDir` | [exec.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/exec.cue) | A (best effort) persistent cache dir |
| `#FS` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/types.cue) | Reference to a filesystem tree | | `#FS` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/types.cue) | Reference to a filesystem tree |
| `#HealthCheck` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/image.cue) | Container health check | | `#HealthCheck` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/image.cue) | Container health check |
| `#ImageConfig` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/image.cue) | Container image config | | `#ImageConfig` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/image.cue) | Container image config |
| `#Mount` | [exec.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/exec.cue) | Transient filesystem mount | | `#Mount` | [exec.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/exec.cue) | Transient filesystem mount |
| `#Ref` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/image.cue) | An address for a remote container image | | `#Ref` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/image.cue) | An address for a remote container image |
| `#Scratch` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/types.cue) | An empty directory | | `#Scratch` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/types.cue) | An empty directory |
| `#Secret` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/types.cue) | Secure reference to an external secret | | `#Secret` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/types.cue) | Secure reference to an external secret |
| `#Socket` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/types.cue) | Reference to a network socket: unix, tcp/udp or npipe | | `#Socket` | [types.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/types.cue) | Reference to a network socket: unix, tcp/udp or npipe |
| `#TempDir` | [exec.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/exec.cue) | A temporary directory for command execution | | `#TempDir` | [exec.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/exec.cue) | A temporary directory for command execution |
### Core actions ### Core actions
@@ -49,23 +49,23 @@ The following core actions are available:
| Definition | File | Description | | Definition | File | Description |
| :-- | :-- | :-- | | :-- | :-- | :-- |
| `#Copy` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Copy files between two filesystem trees | | `#Copy` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Copy files between two filesystem trees |
| `#DecodeSecret` | [secrets.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/secrets.cue) | Decode a secret without leaking its contents | | `#DecodeSecret` | [secrets.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/secrets.cue) | Decode a secret without leaking its contents |
| `#Diff` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Extract the difference between two filesystems as its own file system | | `#Diff` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Extract the difference between two filesystems as its own file system |
| `#Dockerfile` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/image.cue) | Build a container image using a Dockerfile | | `#Dockerfile` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/image.cue) | Build a container image using a Dockerfile |
| `#Exec` | [exec.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/exec.cue) | Execute a command in a docker-compatible container | | `#Exec` | [exec.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/exec.cue) | Execute a command in a docker-compatible container |
| `#Export` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/image.cue) | Export an image as a tar archive | | `#Export` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/image.cue) | Export an image as a tar archive |
| `#GitPull` | [git.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/git.cue) | Download a repository from a remote git server | | `#GitPull` | [git.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/git.cue) | Download a repository from a remote git server |
| `#HTTPFetch` | [http.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/http.cue) | Get a file from an HTTP server | | `#HTTPFetch` | [http.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/http.cue) | Get a file from an HTTP server |
| `#Merge` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Merge multiple filesystem trees | | `#Merge` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Merge multiple filesystem trees |
| `#Mkdir` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Create a directory in a filesystem tree | | `#Mkdir` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Create a directory in a filesystem tree |
| `#NewSecret` | [secrets.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/secrets.cue) | Create a new a secret from a filesystem tree | | `#NewSecret` | [secrets.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/secrets.cue) | Create a new a secret from a filesystem tree |
| `#Pull` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/image.cue) | Download an image from a docker registry | | `#Pull` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/image.cue) | Download an image from a docker registry |
| `#Push` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/image.cue) | Upload an image to a docker registry | | `#Push` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/image.cue) | Upload an image to a docker registry |
| `#ReadFile` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Read a file from a filesystem tree | | `#ReadFile` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Read a file from a filesystem tree |
| `#Scratch` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Create an empty filesystem tree | | `#Scratch` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Create an empty filesystem tree |
| `#Set` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/image.cue) | Modify a docker image | | `#Set` | [image.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/image.cue) | Modify a docker image |
| `#Source` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Access the source for the current CUE package | | `#Source` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Access the source for the current CUE package |
| `#Subdir` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Read a subdirectory from a filesystem tree | | `#Subdir` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Read a subdirectory from a filesystem tree |
| `#TrimSecret` | [secrets.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/secrets.cue) | Trim leading and trailing space characters from a secret | | `#TrimSecret` | [secrets.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/secrets.cue) | Trim leading and trailing space characters from a secret |
| `#WriteFile` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.3/pkg/dagger.io/dagger/core/fs.cue) | Write a file to a filesystem tree | | `#WriteFile` | [fs.cue](https://github.com/dagger/dagger/blob/v0.2.4/pkg/dagger.io/dagger/core/fs.cue) | Write a file to a filesystem tree |

14
docs/getting-started/1200-local-dev.md
View File

@@ -43,10 +43,10 @@ dagger is /opt/homebrew/bin/dagger
If you do not have Homebrew installed, or you want to install a specific version of `dagger`, you can run: If you do not have Homebrew installed, or you want to install a specific version of `dagger`, you can run:
```shell ```shell
curl -L https://dl.dagger.io/dagger/install.sh | DAGGER_VERSION=0.2.0 sh curl -L https://dl.dagger.io/dagger/install.sh | DAGGER_VERSION=0.2.4 sh
./bin/dagger version ./bin/dagger version
dagger 0.2.0 (e499297e) darwin/arm64 dagger 0.2.4 (GIT_SHA) darwin/arm64
``` ```
Before we can build & test our example app with `dagger`, we need to have Docker running. Before we can build & test our example app with `dagger`, we need to have Docker running.
@@ -58,7 +58,7 @@ With Docker running, we are ready to download our example app and run its CI/CD
```shell ```shell
git clone https://github.com/dagger/dagger git clone https://github.com/dagger/dagger
cd dagger cd dagger
git checkout v0.2.3 git checkout v0.2.4
cd pkg/universe.dagger.io/examples/todoapp cd pkg/universe.dagger.io/examples/todoapp
dagger do build dagger do build
@@ -136,10 +136,10 @@ If you want to install dagger to a different location, `cd` where you want `./bi
If you want to install a specific version of `dagger`, you can run: If you want to install a specific version of `dagger`, you can run:
```shell ```shell
curl -L https://dl.dagger.io/dagger/install.sh | DAGGER_VERSION=0.2.0 sh curl -L https://dl.dagger.io/dagger/install.sh | DAGGER_VERSION=0.2.4 sh
./bin/dagger version ./bin/dagger version
dagger 0.2.0 (e499297e) linux/amd64 dagger 0.2.4 (GIT_SHA) linux/amd64
``` ```
Before we can build, test & deploy our example app with `dagger`, we need to have Docker Engine running. Before we can build, test & deploy our example app with `dagger`, we need to have Docker Engine running.
@@ -151,7 +151,7 @@ With Docker Engine running, we are ready to download our example app and run its
```shell ```shell
git clone https://github.com/dagger/dagger git clone https://github.com/dagger/dagger
cd dagger cd dagger
git checkout v0.2.3 git checkout v0.2.4
cd pkg/universe.dagger.io/examples/todoapp cd pkg/universe.dagger.io/examples/todoapp
dagger do build dagger do build
@@ -237,7 +237,7 @@ Still in your `Command Prompt` terminal:
```shell ```shell
git clone https://github.com/dagger/dagger git clone https://github.com/dagger/dagger
cd dagger cd dagger
git checkout v0.2.3 git checkout v0.2.4
cd pkg/universe.dagger.io/examples/todoapp cd pkg/universe.dagger.io/examples/todoapp
dagger do build dagger do build

2
docs/update-version.sh
View File

@@ -9,5 +9,5 @@ then
fi fi
sed --in-place --regexp-extended --expression \ sed --in-place --regexp-extended --expression \
's/v'"${DAGGER_VERSION_FROM:-0.2.0}"'/v'"${DAGGER_VERSION_TO:-0.2.3}"'/g' \ 's/'"${DAGGER_VERSION_FROM:-0.2.3}"'/'"${DAGGER_VERSION_TO:-0.2.4}"'/g' \
./*/*.md ./*/*.md