From 3b3318fc41f5d596f11ba25fb77eeb9e4a9f90a7 Mon Sep 17 00:00:00 2001 From: Rodrigo Coffani Date: Fri, 1 Nov 2024 02:54:08 -0300 Subject: [PATCH 1/2] fix: typo --- mgc/terraform-provider-mgc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mgc/terraform-provider-mgc/README.md b/mgc/terraform-provider-mgc/README.md index 8d515386c..88a155e5d 100644 --- a/mgc/terraform-provider-mgc/README.md +++ b/mgc/terraform-provider-mgc/README.md @@ -15,7 +15,7 @@ The provider is currently under development, so new Magalu Cloud resources will # Participate - You can contribute to an [open issue](https://github.com/MagaluCloud/terraform-provider-mgc/issues) to report a bug or suggest improvements and new features -- You can open tópic in our [Dicussions Forum](https://github.com/MagaluCloud/terraform-provider-mgc/discussions) +- You can open topic in our [Dicussions Forum](https://github.com/MagaluCloud/terraform-provider-mgc/discussions) - See our roadmap in [projects](https://github.com/orgs/MagaluCloud/projects/2/views/7) From e46a0293ad74785e221529e43f4d1532ae8bc1e4 Mon Sep 17 00:00:00 2001 From: Rodrigo Coffani Date: Fri, 1 Nov 2024 03:02:01 -0300 Subject: [PATCH 2/2] feat: contributing docs --- README.md | 6 ++++- mgc/terraform-provider-mgc/CONTRIBUTING.md | 26 ++++++++++++++++++++++ mgc/terraform-provider-mgc/Makefile | 6 +++++ 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 mgc/terraform-provider-mgc/CONTRIBUTING.md diff --git a/README.md b/README.md index 7de746655..c01dace9d 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,10 @@ by Terraform Plugin Provider to perform CRUD on resources. the SDK. The commands can either come from dynamic loaded OpenAPI spec or static modules, i.e: authentication. +* **[terraform-provider-mgc](./mgc/terraform-provider-mgc/)**: Terraform Plugin Provider, +with the same commands and actions defined by the SDK. The provider enables +managing resources on Magalu Cloud. + Most of our code is written in Golang, however there are some utility scripts written in Python as well. @@ -46,7 +50,7 @@ For this, [Poetry](https://python-poetry.org/) is used. Check [Poetry.md](Poetry ## Running the CLI -See [cli/RUNNING.md](./mgc/cli/RUNNING.md) +See [cli/DEVELOPMENT.md](./mgc/cli/DEVELOPMENT.md) ## OpenAPI diff --git a/mgc/terraform-provider-mgc/CONTRIBUTING.md b/mgc/terraform-provider-mgc/CONTRIBUTING.md new file mode 100644 index 000000000..d0e9ec7a3 --- /dev/null +++ b/mgc/terraform-provider-mgc/CONTRIBUTING.md @@ -0,0 +1,26 @@ +## Magalu Cloud Provider + +The MGC provider allows you to use Terraform to manage your resources on Magalu Cloud. + +# Development build + +## Dependencies and build + +```shell +go mod tidy +make build +``` + +## Using local provider + +```terraform +terraform { + required_providers { + mgc = { + source = "terraform.local/local/mgc" + version = "1.0.0" + } + } +} +``` + diff --git a/mgc/terraform-provider-mgc/Makefile b/mgc/terraform-provider-mgc/Makefile index 21e5ec128..4accd6819 100644 --- a/mgc/terraform-provider-mgc/Makefile +++ b/mgc/terraform-provider-mgc/Makefile @@ -107,4 +107,10 @@ setup-config: ## Setup configuration file for Terraform or OpenTofu @echo "File $$config_file written to $$HOME:" @cat $$config_file +build: ## Build the plugin + @echo "Building the plugin..." + @mkdir -p ~/.terraform.d/plugins/terraform.local/local/mgc/1.0.0/linux_amd64/ + @go build -o ~/.terraform.d/plugins/terraform.local/local/mgc/1.0.0/linux_amd64/terraform-provider-mgc_v1.0.0 + @echo "Plugin built successfully." + all: update-subcategory check-example-usage check-empty-subcategory generate-docs setup-config ## Run all tasks