Skip to content

Commit 0977092

Browse files
Vasco de KrijgerVasco de Krijger
authored andcommitted
0 parents  commit 0977092

34 files changed

Lines changed: 2601 additions & 0 deletions

.DS_Store

6 KB
Binary file not shown.

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## 0.1.0 (Unreleased)
2+
3+
FEATURES:

GNUmakefile

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
default: fmt lint install generate
2+
3+
build:
4+
go build -v ./...
5+
6+
install: build
7+
go install -v ./...
8+
9+
lint:
10+
golangci-lint run
11+
12+
generate:
13+
cd tools; go generate ./...
14+
15+
fmt:
16+
gofmt -s -w -e .
17+
18+
test:
19+
go test -v -cover -timeout=120s -parallel=10 ./...
20+
21+
testacc:
22+
TF_ACC=1 go test -v -cover -timeout 120m ./...
23+
24+
.PHONY: fmt lint test testacc build install generate

LICENSE

Lines changed: 375 additions & 0 deletions
Large diffs are not rendered by default.

META.d/_summary.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
schema: 1.1
3+
4+
partition: tf-ecosystem
5+
6+
summary:
7+
owner: team-tf-core-plugins
8+
description: |
9+
Quick start repository for creating a Terraform provider using terraform-plugin-framework
10+
visibility: public

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Terraform Provider Scaffolding (Terraform Plugin Framework)
2+
3+
_This template repository is built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework). The template repository built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk) can be found at [terraform-provider-scaffolding](https://github.com/hashicorp/terraform-provider-scaffolding). See [Which SDK Should I Use?](https://developer.hashicorp.com/terraform/plugin/framework-benefits) in the Terraform documentation for additional information._
4+
5+
This repository is a *template* for a [Terraform](https://www.terraform.io) provider. It is intended as a starting point for creating Terraform providers, containing:
6+
7+
- A resource and a data source (`internal/provider/`),
8+
- Examples (`examples/`) and generated documentation (`docs/`),
9+
- Miscellaneous meta files.
10+
11+
These files contain boilerplate code that you will need to edit to create your own Terraform provider. Tutorials for creating Terraform providers can be found on the [HashiCorp Developer](https://developer.hashicorp.com/terraform/tutorials/providers-plugin-framework) platform. _Terraform Plugin Framework specific guides are titled accordingly._
12+
13+
Please see the [GitHub template repository documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for how to create a new repository from this template on GitHub.
14+
15+
Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://developer.hashicorp.com/terraform/registry/providers/publishing) so that others can use it.
16+
17+
## Requirements
18+
19+
- [Terraform](https://developer.hashicorp.com/terraform/downloads) >= 1.0
20+
- [Go](https://golang.org/doc/install) >= 1.24
21+
22+
## Building The Provider
23+
24+
1. Clone the repository
25+
1. Enter the repository directory
26+
1. Build the provider using the Go `install` command:
27+
28+
```shell
29+
go install
30+
```
31+
32+
## Adding Dependencies
33+
34+
This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
35+
Please see the Go documentation for the most up to date information about using Go modules.
36+
37+
To add a new dependency `github.com/author/dependency` to your Terraform provider:
38+
39+
```shell
40+
go get github.com/author/dependency
41+
go mod tidy
42+
```
43+
44+
Then commit the changes to `go.mod` and `go.sum`.
45+
46+
## Using the provider
47+
48+
Fill this in for each provider
49+
50+
## Developing the Provider
51+
52+
If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).
53+
54+
To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
55+
56+
To generate or update documentation, run `make generate`.
57+
58+
In order to run the full suite of Acceptance tests, run `make testacc`.
59+
60+
*Note:* Acceptance tests create real resources, and often cost money to run.
61+
62+
```shell
63+
make testacc
64+
```

docs/data-sources/example.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "scaffolding_example Data Source - scaffolding"
4+
subcategory: ""
5+
description: |-
6+
Example data source
7+
---
8+
9+
# scaffolding_example (Data Source)
10+
11+
Example data source
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "scaffolding_example" "example" {
17+
configurable_attribute = "some-value"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Optional
25+
26+
- `configurable_attribute` (String) Example configurable attribute
27+
28+
### Read-Only
29+
30+
- `id` (String) Example identifier
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "scaffolding_example Ephemeral Resource - scaffolding"
4+
subcategory: ""
5+
description: |-
6+
Example ephemeral resource
7+
---
8+
9+
# scaffolding_example (Ephemeral Resource)
10+
11+
Example ephemeral resource
12+
13+
## Example Usage
14+
15+
```terraform
16+
ephemeral "scaffolding_example" "example" {
17+
configurable_attribute = "some-value"
18+
}
19+
```
20+
21+
<!-- schema generated by tfplugindocs -->
22+
## Schema
23+
24+
### Required
25+
26+
- `configurable_attribute` (String) Example configurable attribute
27+
28+
### Read-Only
29+
30+
- `value` (String) Example value

docs/functions/example.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "example function - scaffolding"
4+
subcategory: ""
5+
description: |-
6+
Example function
7+
---
8+
9+
# function: example
10+
11+
Echoes given argument as result
12+
13+
14+
15+
## Signature
16+
17+
<!-- signature generated by tfplugindocs -->
18+
```text
19+
example(input string) string
20+
```
21+
22+
## Arguments
23+
24+
<!-- arguments generated by tfplugindocs -->
25+
1. `input` (String) String to echo

docs/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "scaffolding Provider"
4+
description: |-
5+
6+
---
7+
8+
# scaffolding Provider
9+
10+
11+
12+
## Example Usage
13+
14+
```terraform
15+
provider "scaffolding" {
16+
# example configuration here
17+
}
18+
```
19+
20+
<!-- schema generated by tfplugindocs -->
21+
## Schema
22+
23+
### Optional
24+
25+
- `endpoint` (String) Example provider attribute

0 commit comments

Comments
 (0)