From 64e9027bbefc31c635cc731bec969f98036a3fad Mon Sep 17 00:00:00 2001 From: Joel Longtine Date: Thu, 16 Dec 2021 15:37:55 -0700 Subject: [PATCH] add git + argocd docs Signed-off-by: Joel Longtine --- docs/reference/argocd.md | 48 ++++++++++++++++++++-------------------- docs/reference/git.md | 22 +++++++++--------- 2 files changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/reference/argocd.md b/docs/reference/argocd.md index 11264085..53ddf353 100644 --- a/docs/reference/argocd.md +++ b/docs/reference/argocd.md @@ -21,7 +21,7 @@ Create an ArgoCD application |*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*config.server* | `string` |ArgoCD server | |*config.project* | `*"default" \| string` |ArgoCD project | -|*config.token* | `*null \| {}` |ArgoCD authentication token | +|*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token | |*name* | `string` |App name | |*repo* | `string` |Repository url (git or helm) | |*path* | `string` |Folder to deploy | @@ -29,7 +29,7 @@ Create an ArgoCD application |*image.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*image.config.server* | `string` |ArgoCD server | |*image.config.project* | `*"default" \| string` |ArgoCD project | -|*image.config.token* | `*null \| {}` |ArgoCD authentication token | +|*image.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token | |*namespace* | `*"default" \| string` |Destination namespace | |*env.APP_NAME* | `string` |- | |*env.APP_REPO* | `string` |- | @@ -47,12 +47,12 @@ Re-usable CLI component ### argocd.#CLI Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | -|*config.server* | `string` |ArgoCD server | -|*config.project* | `*"default" \| string` |ArgoCD project | -|*config.token* | `*null \| {}` |ArgoCD authentication token | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | +|*config.server* | `string` |ArgoCD server | +|*config.project* | `*"default" \| string` |ArgoCD project | +|*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token | ### argocd.#CLI Outputs @@ -64,12 +64,12 @@ ArgoCD configuration ### argocd.#Config Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | -|*server* | `string` |ArgoCD server | -|*project* | `*"default" \| string` |ArgoCD project | -|*token* | `*null \| {}` |ArgoCD authentication token | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | +|*server* | `string` |ArgoCD server | +|*project* | `*"default" \| string` |ArgoCD project | +|*token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token | ### argocd.#Config Outputs @@ -81,13 +81,13 @@ Get application's status ### argocd.#Status Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | -|*config.server* | `string` |ArgoCD server | -|*config.project* | `*"default" \| string` |ArgoCD project | -|*config.token* | `*null \| {}` |ArgoCD authentication token | -|*name* | `string` |ArgoCD application | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | +|*config.server* | `string` |ArgoCD server | +|*config.project* | `*"default" \| string` |ArgoCD project | +|*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token | +|*name* | `string` |ArgoCD application | ### argocd.#Status Outputs @@ -111,18 +111,18 @@ Sync an application to its targer state |*config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*config.server* | `string` |ArgoCD server | |*config.project* | `*"default" \| string` |ArgoCD project | -|*config.token* | `*null \| {}` |ArgoCD authentication token | +|*config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token | |*application* | `string` |ArgoCD application | |*wait* | `*false \| bool` |Wait the application to sync correctly | |*ctr.image.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*ctr.image.config.server* | `string` |ArgoCD server | |*ctr.image.config.project* | `*"default" \| string` |ArgoCD project | -|*ctr.image.config.token* | `*null \| {}` |ArgoCD authentication token | +|*ctr.image.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token | |*ctr.env.APPLICATION* | `string` |- | |*status.config.version* | `*"v2.0.5" \| string` |ArgoCD CLI binary version | |*status.config.server* | `string` |ArgoCD server | |*status.config.project* | `*"default" \| string` |ArgoCD project | -|*status.config.token* | `*null \| {}` |ArgoCD authentication token | +|*status.config.token* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |ArgoCD authentication token | |*status.name* | `string` |ArgoCD application | ### argocd.#Sync Outputs diff --git a/docs/reference/git.md b/docs/reference/git.md index bb0d9bfa..ae6e60a2 100644 --- a/docs/reference/git.md +++ b/docs/reference/git.md @@ -16,15 +16,15 @@ Commit & push to git repository ### git.#Commit Inputs -| Name | Type | Description | -| ------------- |:-------------: |:-------------: | -|*repository.remote* | `string` |Repository remote URL | -|*repository.authToken* | `*null \| {}` |Authentication token (PAT or password) | -|*repository.branch* | `string` |Git branch | -|*name* | `string` |Username | -|*email* | `string` |Email | -|*message* | `string` |Commit message | -|*force* | `*false \| bool` |Force push options | +| Name | Type | Description | +| ------------- |:-------------: |:-------------: | +|*repository.remote* | `string` |Repository remote URL | +|*repository.authToken* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |Authentication token (PAT or password) | +|*repository.branch* | `string` |Git branch | +|*name* | `string` |Username | +|*email* | `string` |Email | +|*message* | `string` |Commit message | +|*force* | `*false \| bool` |Force push options | ### git.#Commit Outputs @@ -69,8 +69,8 @@ A git repository |*remote* | `string` |Git remote link | |*ref* | `string` |Git ref: can be a commit, tag or branch. Example: "main" | |*subdir* | `*null \| string` |(optional) Subdirectory | -|*authToken* | `*null \| {}` |(optional) Add Personal Access Token | -|*authHeader* | `*null \| {}` |(optional) Add OAuth Token | +|*authToken* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |(optional) Add Personal Access Token | +|*authHeader* | `*null \| {\n $dagger: {\n secret: {}\n }\n}` |(optional) Add OAuth Token | ### git.#Repository Outputs