소스 검색

Generate docs, update docker compose, add copyright headers.

Frederic G. MARAND 5 달 전
부모
커밋
761c115db4

+ 4 - 0
.copywrite.hcl

@@ -12,6 +12,10 @@ project {
     # GitHub issue template configuration
     ".github/ISSUE_TEMPLATE/*.yml",
 
+    # Goland configuration
+    ".idea/**",
+    ".run/**",
+
     # golangci-lint tooling configuration
     ".golangci.yml",
 

+ 12 - 0
.run/Run plugin.run.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run plugin" type="GoApplicationRunConfiguration" factoryName="Go Application">
+    <module name="terraform-provider-hashicups" />
+    <working_directory value="$PROJECT_DIR$" />
+    <parameters value="-debug" />
+    <kind value="PACKAGE" />
+    <package value="terraform-provider-hashicups" />
+    <directory value="$PROJECT_DIR$" />
+    <filePath value="$PROJECT_DIR$/main.go" />
+    <method v="2" />
+  </configuration>
+</component>

+ 6 - 1
docker_compose/docker-compose.yml

@@ -1,4 +1,9 @@
-version: '3.7'
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: MPL-2.0
+
+# Version attribute is obsolete
+# version: '3.7'
+
 services:
   api:
     image: "hashicorpdemoapp/product-api:v0.0.22"

+ 40 - 0
docs/data-sources/coffees.md

@@ -0,0 +1,40 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "hashicups_coffees Data Source - hashicups"
+subcategory: ""
+description: |-
+  
+---
+
+# hashicups_coffees (Data Source)
+
+
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `coffees` (Attributes List) (see [below for nested schema](#nestedatt--coffees))
+
+<a id="nestedatt--coffees"></a>
+### Nested Schema for `coffees`
+
+Read-Only:
+
+- `description` (String)
+- `id` (Number)
+- `image` (String)
+- `ingredients` (Attributes List) (see [below for nested schema](#nestedatt--coffees--ingredients))
+- `name` (String)
+- `price` (Number)
+- `teaser` (String)
+
+<a id="nestedatt--coffees--ingredients"></a>
+### Nested Schema for `coffees.ingredients`
+
+Read-Only:
+
+- `id` (Number)

+ 0 - 30
docs/data-sources/example.md

@@ -1,30 +0,0 @@
----
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding_example Data Source - scaffolding"
-subcategory: ""
-description: |-
-  Example data source
----
-
-# scaffolding_example (Data Source)
-
-Example data source
-
-## Example Usage
-
-```terraform
-data "scaffolding_example" "example" {
-  configurable_attribute = "some-value"
-}
-```
-
-<!-- schema generated by tfplugindocs -->
-## Schema
-
-### Optional
-
-- `configurable_attribute` (String) Example configurable attribute
-
-### Read-Only
-
-- `id` (String) Example identifier

+ 0 - 26
docs/functions/example.md

@@ -1,26 +0,0 @@
----
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "example function - scaffolding"
-subcategory: ""
-description: |-
-  Example function
----
-
-# function: example
-
-Echoes given argument as result
-
-
-
-## Signature
-
-<!-- signature generated by tfplugindocs -->
-```text
-example(input string) string
-```
-
-## Arguments
-
-<!-- arguments generated by tfplugindocs -->
-1. `input` (String) String to echo
-

+ 5 - 3
docs/index.md

@@ -1,12 +1,12 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding Provider"
+page_title: "hashicups Provider"
 subcategory: ""
 description: |-
   
 ---
 
-# scaffolding Provider
+# hashicups Provider
 
 
 
@@ -23,4 +23,6 @@ provider "scaffolding" {
 
 ### Optional
 
-- `endpoint` (String) Example provider attribute
+- `host` (String)
+- `password` (String, Sensitive)
+- `username` (String)

+ 0 - 31
docs/resources/example.md

@@ -1,31 +0,0 @@
----
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding_example Resource - scaffolding"
-subcategory: ""
-description: |-
-  Example resource
----
-
-# scaffolding_example (Resource)
-
-Example resource
-
-## Example Usage
-
-```terraform
-resource "scaffolding_example" "example" {
-  configurable_attribute = "some-value"
-}
-```
-
-<!-- schema generated by tfplugindocs -->
-## Schema
-
-### Optional
-
-- `configurable_attribute` (String) Example configurable attribute
-- `defaulted` (String) Example configurable attribute with default value
-
-### Read-Only
-
-- `id` (String) Example identifier

+ 3 - 0
internal/provider/coffees_data_source.go

@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package provider
 
 import (

+ 1 - 0
terraformrc.tf

@@ -0,0 +1 @@
+/Users/fredericmarand/.terraformrc