diff --git a/docs/reference/README.md b/docs/reference/README.md index 2db698fa..78ff3c71 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -14,6 +14,7 @@ - [azure/resourcegroup](./azure/resourcegroup.md) - - - [azure/staticwebapp](./azure/staticwebapp.md) - - - [azure/storage](./azure/storage.md) - - +- [bats](./bats.md) - - - [dagger](./dagger/README.md) - Dagger core types - [dagger/engine](./dagger/engine.md) - - - [dagger/op](./dagger/op.md) - op: low-level operations for Dagger processing pipelines diff --git a/docs/reference/bats.md b/docs/reference/bats.md new file mode 100644 index 00000000..b05427c7 --- /dev/null +++ b/docs/reference/bats.md @@ -0,0 +1,22 @@ +--- +sidebar_label: bats +--- + +# alpha.dagger.io/bats + +```cue +import "alpha.dagger.io/bats" +``` + +## bats.#Bats + +### bats.#Bats Inputs + +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*source* | `dagger.#Artifact` |Source containing bats files | +|*ctr.mount."/src".from* | `dagger.#Artifact` |- | + +### bats.#Bats Outputs + +_No output._ diff --git a/docs/reference/dagger/engine.md b/docs/reference/dagger/engine.md new file mode 100644 index 00000000..27d996d4 --- /dev/null +++ b/docs/reference/dagger/engine.md @@ -0,0 +1,67 @@ +--- +sidebar_label: engine +--- + +# alpha.dagger.io/dagger/engine + +```cue +import "alpha.dagger.io/dagger/engine" +``` + +## engine.#Context + +### engine.#Context Inputs + +_No input._ + +### engine.#Context Outputs + +_No output._ + +## engine.#FS + +A reference to a filesystem tree. For example: - The root filesystem of a container - A source code repository - A directory containing binary artifacts Rule of thumb: if it fits in a tar archive, it fits in a #FS. + +### engine.#FS Inputs + +_No input._ + +### engine.#FS Outputs + +_No output._ + +## engine.#Plan + +A deployment plan executed by `dagger up` + +### engine.#Plan Inputs + +_No input._ + +### engine.#Plan Outputs + +_No output._ + +## engine.#Secret + +A reference to an external secret, for example: - A password - A SSH private key - An API token Secrets are never merged in the Cue tree. They can only be used by a special filesystem mount designed to minimize leak risk. + +### engine.#Secret Inputs + +_No input._ + +### engine.#Secret Outputs + +_No output._ + +## engine.#Service + +A reference to a network service endpoint, for example: - A TCP or UDP port - A unix or npipe socket - An HTTPS endpoint + +### engine.#Service Inputs + +_No input._ + +### engine.#Service Outputs + +_No output._