feat: add initial provider (#2)

* feat: add initial provider

* fix: remove issue bot workflow

* refactor: improved string slice conversion function name

* docs: changed calculate checksum to compute

* docs: changed calculate checksum to compute

Author: WassimKallel

.github/workflows/add-content-to-project.yml

@@ -1,64 +1,29 @@
-# Terraform Provider Scaffolding (Terraform Plugin SDK)
+# Dirhash
+Computing the checksum of a directory made easy.
 
-_This template repository is built on the [Terraform Plugin SDK](https://github.com/hashicorp/terraform-plugin-sdk). The template repository built on the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework) can be found at [terraform-provider-scaffolding-framework](https://github.com/hashicorp/terraform-provider-scaffolding-framework). See [Which SDK Should I Use?](https://www.terraform.io/docs/plugin/which-sdk.html) in the Terraform documentation for additional information._
+## Dirhash Provider
+Dirhash was created to compute the checksum of a directory, 
+a useful provider if you try to make Terraform react and make changes 
+based on whether changes have been made inside a directory or not.
 
-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:
-
- - A resource, and a data source (`internal/provider/`),
- - Examples (`examples/`) and generated documentation (`docs/`),
- - Miscellaneous meta files.
- 
-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 Learn](https://learn.hashicorp.com/collections/terraform/providers) platform.
-
-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.
-
-Once you've written your provider, you'll want to [publish it on the Terraform Registry](https://www.terraform.io/docs/registry/providers/publishing.html) so that others can use it.
-
-
-## Requirements
-
--	[Terraform](https://www.terraform.io/downloads.html) >= 0.13.x
--	[Go](https://golang.org/doc/install) >= 1.18
-
-## Building The Provider
-
-1. Clone the repository
-1. Enter the repository directory
-1. Build the provider using the Go `install` command: 
-```sh
-$ go install
-```
-
-## Adding Dependencies
-
-This provider uses [Go modules](https://github.com/golang/go/wiki/Modules).
-Please see the Go documentation for the most up to date information about using Go modules.
-
-To add a new dependency `github.com/author/dependency` to your Terraform provider:
 
+### Usage
+As noted above, the Dirhash provider can compute the checksum of a directory, 
+the data_source `dirhash_sha256` can be used to retrieve the SHA256 of a directory.
+For example:
+```terraform
+provider "dirhash" {}
 ```
-go get github.com/author/dependency
-go mod tidy
-```
-
-Then commit the changes to `go.mod` and `go.sum`.
-
-## Using the provider
-
-Fill this in for each provider
-
-## Developing the Provider
-
-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).
-
-To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
-
-To generate or update documentation, run `go generate`.
-
-In order to run the full suite of Acceptance tests, run `make testacc`.
-
-*Note:* Acceptance tests create real resources, and often cost money to run.
-
-```sh
-$ make testacc
+```terraform
+data "dirhash_sha256" "example" {
+  directory = "/path/to/directory"
+  ignore = [
+    "glob_pattern_1/*",
+    "glob_pattern_2/*"
+  ]
+}
+output "directory_sha256_checksum" {
+  description = "the Output SHA256 Checksum for the directory"
+  value       = data.dirhash_sha256.example.checksum
+}
 ```

README.md

@@ -0,0 +1,46 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "dirhash_sha256 Data Source - terraform-provider-dirhash"
+subcategory: ""
+description: |-
+  Compute SHA256 checksum of a given directory
+---
+
+# dirhash_sha256 (Data Source)
+
+Compute SHA256 checksum of a given directory
+
+## Example Usage
+
+```terraform
+data "dirhash_sha256" "example" {
+  directory = "/path/to/directory"
+  ignore = [
+    "glob_pattern_1/*",
+    "glob_pattern_2/*"
+  ]
+}
+
+output "directory_sha256_checksum" {
+  description = "the Output SHA256 Checksum for the directory"
+  value       = data.dirhash_sha256.example.checksum
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `directory` (String) Directory to hash.
+
+### Optional
+
+- `ignore` (List of String) List of ignored glob patterns.
+
+### Read-Only
+
+- `checksum` (String) Directory SHA 256 Checksum
+- `id` (String) The ID of this resource.
+
+

docs/data-sources/data_source.md

@@ -1,22 +1,36 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "scaffolding Provider"
-subcategory: ""
+page_title: "Provider: Dirhash"
 description: |-
-  
+  Compute checksum for a given directory
 ---
 
-# scaffolding Provider
+# Dirhash Provider
 
+Dirhash was created to compute the checksum of a directory, 
+a useful provider if you try to make Terraform react and make changes 
+based on whether changes have been made inside a directory or not.
 
+## Data Source "dirhash_sha256"
 
-## Example Usage
+As noted above, the Dirhash provider can compute the checksum of a directory, 
+the data_source `dirhash_sha256` can be used to retrieve the SHA256 of a directory.
+
+For example:
 
 ```terraform
-provider "scaffolding" {
-  # example configuration here
-}
+provider "dirhash" {}
 ```
+```terraform
+data "dirhash_sha256" "example" {
+  directory = "/path/to/directory"
+  ignore = [
+    "glob_pattern_1/*",
+    "glob_pattern_2/*"
+  ]
+}
 
-<!-- schema generated by tfplugindocs -->
-## Schema
+output "directory_sha256_checksum" {
+  description = "the Output SHA256 Checksum for the directory"
+  value       = data.dirhash_sha256.example.checksum
+}
+```

docs/data-sources/sha256.md

@@ -0,0 +1,12 @@
+data "dirhash_sha256" "example" {
+  directory = "/path/to/directory"
+  ignore = [
+    "glob_pattern_1/*",
+    "glob_pattern_2/*"
+  ]
+}
+
+output "directory_sha256_checksum" {
+  description = "the Output SHA256 Checksum for the directory"
+  value       = data.dirhash_sha256.example.checksum
+}

docs/index.md

@@ -1,3 +1 @@
-provider "scaffolding" {
-  # example configuration here
-}
+provider "dirhash" {}