diff --git a/README.md b/README.md index e31d229..747e5d7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# daggerverse Vault Module +# Daggerverse Vault Module [Dagger](https://dagger.io/) module for [daggerverse](https://daggerverse.dev/) providing Vault functionality. The Dagger module is located in the [vault-kv](./vault-kv/) directory. -## usage +## Usage Basic usage guide. @@ -14,7 +14,7 @@ Check the official Dagger Module documentation: https://docs.dagger.io/ The [Dagger CLI](https://docs.dagger.io/cli) is needed. -### functions +### Functions List all functions of the module. This command is provided by the [Dagger CLI](https://docs.dagger.io/reference/cli/). @@ -24,46 +24,30 @@ dagger functions -m ./vault-kv/ The vault-kv module is referenced locally. -## development +## Development Basic development guide. -### setup Dagger module - -Setup the Dagger module. - -Create the directory for the module and initialize it. +### Set up Dagger module ```bash -mkdir vault-kv/ +# enter into the module's directory cd vault-kv/ - -# initialize Dagger module -dagger mod init --sdk go --name vault-kv +# initialize the module +dagger develop --sdk go ``` -### setup test module - -Set up the outer module to test Dagger vault-kv module. - -```bash -dagger mod init --sdk go --name vault -dagger mod use ./vault-kv -``` - -Generate or re-generate the Go definitions file (dagger.gen.go) for use in code completion. - -```bash -dagger mod install -``` - -The functions of the module are available by the `dag` variable. Type `dag.` in your Go file for code completion. - +### Testing -Update the module: +This module contains a testing module that aims to test Dagger vault-kv module. ```bash -dagger mod update +# enter into the test module's directory +cd vault-kv/tests +# initialize the module +dagger develop --sdk go +# execute the tests +dagger call test ``` ## To Do diff --git a/vault-kv/tests/.gitattributes b/vault-kv/tests/.gitattributes new file mode 100644 index 0000000..3a45493 --- /dev/null +++ b/vault-kv/tests/.gitattributes @@ -0,0 +1,4 @@ +/dagger.gen.go linguist-generated +/internal/dagger/** linguist-generated +/internal/querybuilder/** linguist-generated +/internal/telemetry/** linguist-generated