From 1bb6e021cfc385dfc33f8460e0d1fd5f1cac5df4 Mon Sep 17 00:00:00 2001 From: Jon Morehouse Date: Sun, 19 May 2024 16:34:53 -0600 Subject: [PATCH] fix: require directory names (#133) chore: make `directory` required for vcs configs --- docs/resources/app_installer.md | 37 ++++++++++++++++++++ docs/resources/app_sandbox.md | 5 +-- docs/resources/docker_build_component.md | 5 +-- docs/resources/helm_chart_component.md | 5 +-- docs/resources/terraform_module_component.md | 5 +-- internal/provider/shared_attributes.go | 4 +-- 6 files changed, 43 insertions(+), 18 deletions(-) create mode 100644 docs/resources/app_installer.md diff --git a/docs/resources/app_installer.md b/docs/resources/app_installer.md new file mode 100644 index 0000000..a03572a --- /dev/null +++ b/docs/resources/app_installer.md @@ -0,0 +1,37 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "nuon_app_installer Resource - terraform-provider-nuon" +subcategory: "" +description: |- + A public installer page for a nuon app. +--- + +# nuon_app_installer (Resource) + +A public installer page for a nuon app. + + + + +## Schema + +### Required + +- `app_id` (String) The application ID. +- `community_url` (String) Community url to a slack or discord, etc. +- `description` (String) Short description of app. +- `documentation_url` (String) Documentation url +- `github_url` (String) GitHub url, link to application. +- `homepage_url` (String) Homepage url +- `logo_url` (String) Logo image to display on page. +- `name` (String) App name to render on install page. +- `post_install_markdown` (String) Markdown that will be shown to users after a successful install. Supports interpolation. +- `slug` (String) URL slug to access app from. + +### Optional + +- `demo_url` (String) Demo url to show + +### Read-Only + +- `id` (String) The unique ID of the app. diff --git a/docs/resources/app_sandbox.md b/docs/resources/app_sandbox.md index 710c69f..abb87a8 100644 --- a/docs/resources/app_sandbox.md +++ b/docs/resources/app_sandbox.md @@ -50,12 +50,9 @@ Optional: Required: - `branch` (String) The default branch to create new builds from. +- `directory` (String) The directory the component code is in. Use ./ for root. - `repo` (String) The https clone url -Optional: - -- `directory` (String) The directory the component code is in. - ### Nested Schema for `var` diff --git a/docs/resources/docker_build_component.md b/docs/resources/docker_build_component.md index 1ca5c1e..c6538d9 100644 --- a/docs/resources/docker_build_component.md +++ b/docs/resources/docker_build_component.md @@ -100,8 +100,5 @@ Required: Required: - `branch` (String) The default branch to create new builds from. +- `directory` (String) The directory the component code is in. Use ./ for root. - `repo` (String) The https clone url - -Optional: - -- `directory` (String) The directory the component code is in. diff --git a/docs/resources/helm_chart_component.md b/docs/resources/helm_chart_component.md index 9b917e2..bdc6a27 100644 --- a/docs/resources/helm_chart_component.md +++ b/docs/resources/helm_chart_component.md @@ -94,12 +94,9 @@ Optional: Required: - `branch` (String) The default branch to create new builds from. +- `directory` (String) The directory the component code is in. Use ./ for root. - `repo` (String) The https clone url -Optional: - -- `directory` (String) The directory the component code is in. - ### Nested Schema for `value` diff --git a/docs/resources/terraform_module_component.md b/docs/resources/terraform_module_component.md index 64071b8..42c34db 100644 --- a/docs/resources/terraform_module_component.md +++ b/docs/resources/terraform_module_component.md @@ -101,12 +101,9 @@ Required: Required: - `branch` (String) The default branch to create new builds from. +- `directory` (String) The directory the component code is in. Use ./ for root. - `repo` (String) The https clone url -Optional: - -- `directory` (String) The directory the component code is in. - ### Nested Schema for `var` diff --git a/internal/provider/shared_attributes.go b/internal/provider/shared_attributes.go index 492b47f..7803a80 100644 --- a/internal/provider/shared_attributes.go +++ b/internal/provider/shared_attributes.go @@ -25,8 +25,8 @@ func publicRepoAttribute() schema.SingleNestedAttribute { Required: true, }, "directory": schema.StringAttribute{ - Description: "The directory the component code is in.", - Optional: true, + Description: "The directory the component code is in. Use ./ for root.", + Required: true, }, }, }