Merge pull request #2 from piroux-sg/release/v0.1.0-beta1

Release/v0.1.0-beta1

.gitignore

@@ -1,23 +1,52 @@
-# If you prefer the allow list template instead of the deny list, see community template:
-# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
-#
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
+### Terraform ###
+# Local .terraform directories
+**/.terraform/*
 
-# Test binary, built with `go test -c`
-*.test
+# .tfstate files
+*.tfstate
+*.tfstate.*
 
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
+# Crash log files
+crash.log
+crash.*.log
 
-# Dependency directories (remove the comment below to include it)
-# vendor/
+# Lock files
+.terraform.lock.hcl
 
-# Go workspace file
-go.work
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
 
-.DS_Store
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
+
+# Terraform provider build files
+terraform-provider-stackguardian
+terraform-registry-manifest.json
+
+
+### Go ###
+dist
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride

.goreleaser.yml

@@ -1,60 +1,74 @@
-# Visit https://goreleaser.com for documentation on how to customize this
-# behavior.
+# https://goreleaser.com
+
+project_name: terraform-provider-stackguardian
+
+#  env_files:
+#    github_token: '{{ .Env.SG_GITHUB_KEY_FILEPATH }}'
+
 before:
   hooks:
-    # this is just an example and not a requirement for provider building/publishing
+    # This is just an example and not a requirement for provider building/publishing
+    # Is it really required?
     - go mod tidy
+
 builds:
   - env:
-      # goreleaser does not work with CGO, it could also complicate
-      # usage by users in CI/CD systems like Terraform Cloud where
-      # they are unable to install libraries.
       - CGO_ENABLED=0
+      - GOPRIVATE="github.com/StackGuardian/terraform-provider-stackguardian"
     mod_timestamp: '{{ .CommitTimestamp }}'
     flags:
-      - -trimpath
+      - '-trimpath'
+      - '-v'
     ldflags:
       - '-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}'
     goos:
-      - freebsd
-      - windows
-      - linux
       - darwin
+      - linux
+      - windows
     goarch:
       - amd64
-      - '386'
-      - arm
       - arm64
-    ignore:
-      - goos: darwin
-        goarch: '386'
     binary: '{{ .ProjectName }}_v{{ .Version }}'
+
 archives:
   - format: zip
     name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}'
+
 checksum:
-  extra_files:
-    - glob: 'terraform-registry-manifest.json'
-      name_template: '{{ .ProjectName }}_{{ .Version }}_manifest.json'
   name_template: '{{ .ProjectName }}_{{ .Version }}_SHA256SUMS'
   algorithm: sha256
-signs:
-  - artifacts: checksum
-    args:
-      # if you are using this in a GitHub action or some other automated pipeline, you
-      # need to pass the batch flag to indicate its not interactive.
-      - "--batch"
-      - "--local-user"
-      - "{{ .Env.GPG_FINGERPRINT }}" # set this environment variable for your signing key
-      - "--output"
-      - "${signature}"
-      - "--detach-sign"
-      - "${artifact}"
+  #  extra_files:
+  #    - glob: 'terraform-registry-manifest.json'
+  #      name_template: '{{ .ProjectName }}_{{ .Version }}_manifest.json'
+
+# https://goreleaser.com/ci/actions/#signing
+#  signs:
+#    - artifacts: checksum
+#      args:
+#        # if you are using this in a GitHub action or some other automated pipeline, you
+#        # need to pass the batch flag to indicate its not interactive.
+#        - "--batch"
+#        - "--local-user"
+#        - "{{ .Env.GPG_FINGERPRINT }}" # set this environment variable for your signing key
+#        - "--output"
+#        - "${signature}"
+#        - "--detach-sign"
+#        - "${artifact}"
+
 release:
-  extra_files:
-    - glob: 'terraform-registry-manifest.json'
-      name_template: '{{ .ProjectName }}_{{ .Version }}_manifest.json'
-  # If you want to manually examine the release before its live, uncomment this line:
-  # draft: true
+  name_template: "v{{.Version}}"
+  github:
+    owner: stackguardian
+    name: terraform-provider-stackguardian
+  #  extra_files:
+  #    - glob: 'terraform-registry-manifest.json'
+  #      name_template: '{{ .ProjectName }}_{{ .Version }}_manifest.json'
+  draft: true
+  replace_existing_draft: true
+  prerelease: auto
+  mode: append
+  skip_upload: false
+
 changelog:
-  skip: true
+  skip: true
+  use: github

.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Attach to TF Plugin",
+            "type": "go",
+            "request": "attach",
+            "mode": "local",
+            "processId": 0,
+            //"preLaunchTask": "Exec sg-tf-provider",
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,19 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "shell",
+			"label": "Exec sg-tf-provider",
+			// Env Var STACKGUARDIAN_API_KEY is required
+			"command": "if not set -q STACKGUARDIAN_API_KEY; echo 'Env Var STACKGUARDIAN_API_KEY is required'; else; rm -rfv .terraform .terraform.lock.hcl && pushd ../..; if not make; popd && echo 'BUILD KO'; else; popd && echo 'BUILD OK' && terraform init && TF_LOG= terraform plan; TF_LOG= terraform apply; end; end;",
+			"options": {
+				"cwd": "examples/workflow_outputs_example"
+			},
+			"group": {
+				"kind": "test",
+				"isDefault": true
+			},
+			"problemMatcher": []
+		}
+	]
+}

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+
+
+## [0.1.0-beta1] - 2023-12-21
+
+### Added
+
+- TF Data-Source for StackGuardian Workflow Outputs
+
+
+## [0.1.0-alpha1] - 2023-10-16
+
+### Added
+
+- Initial TF provider for StackGuardian
+- TF Resource and Data-Source for StackGuardian Workflow
+- TF Resource and Data-Source for StackGuardian Stack
+- TF Resource and Data-Source for StackGuardian Policy
+- TF Resource and Data-Source for StackGuardian Integration

CODE_OF_CONDUCT.md

@@ -0,0 +1,138 @@
+This project has adopted the [Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+For more information see the [Code of Conduct FAQ](https://www.contributor-covenant.org/faq/) or contact
+[email protected] with any additional questions or comments.
+
+<br>
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations