Merge pull request #2 from StatusCakeDev/separate-feature-variables-into-objects

refactor: separate feature variables into objects

Author: tomasbasham

.editorconfig

@@ -4,7 +4,6 @@
 
 root = true
 
-
 [*]
 end_of_line = lf
 charset = utf-8
@@ -13,9 +12,6 @@ insert_final_newline = true
 indent_style = space
 indent_size = 2
 
-[*.{tf,tfvars}]
-indent_size = 2
-
 [*.{diff,md}]
 trim_trailing_whitespace = false
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,28 +10,31 @@ assignees: ''
 A clear and concise description of what the bug is.
 
 **To Reproduce**
-Steps to reproduce the behavior:
+Steps to reproduce the behaviour:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+**Expected behaviour**
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/policy.yaml

@@ -42,11 +42,26 @@ jobs:
         node-version: 19.x
     - name: Install base config
       run: npm install @commitlint/config-conventional
-    - name: Validate all commits
+    - name: Validate commit messages
       run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to HEAD --verbose
+  markdown-style:
+    name: Check markdown style
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 19.x
+    - name: Validate markdown
+      run: npx markdownlint-cli2 **/*.md
   terraform:
-    name: Check Terraform configuration formatting
+    name: Check Terraform configuration style
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
     env:
       TF_IN_AUTOMATION: 1
       TF_INPUT: 0
@@ -55,7 +70,71 @@ jobs:
     - uses: hashicorp/setup-terraform@v2
       with:
         terraform_version: 1.3.6
-    - run: terraform fmt -check -recursive
+    - name: Check Terraform configuration
+      id: fmt
+      run: terraform fmt -check -recursive -diff
+    - name: Initialise Terraform configuration
+      id: init
+      run: terraform init -backend=false
+    - name: Validate Terraform configuration
+      id: validate
+      run: terraform validate -no-color
+    - uses: actions/github-script@v6
+      if: github.event_name == 'pull_request'
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        script: |
+          // Retrieve existing bot comments for the PR.
+          const { data: comments } = await github.rest.issues.listComments({
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            issue_number: context.issue.number,
+          });
+
+          const botComment = comments.find(comment => {
+            return comment.user.type === 'Bot' && comment.body.includes('Terraform Format and Style')
+          });
+
+          const formatSummary = `${{ steps.fmt.outputs.stdout }}`.trim() || 'No difference';
+
+          // Prepare format of the comment.
+          const output = `| Step | Result |
+          |------|--------|
+          | Terraform Format and Style | \`${{ steps.fmt.outcome }}\` |
+          | Terraform Initialization | \`${{ steps.init.outcome }}\` |
+          | Terraform Validation | \`${{ steps.validate.outcome }}\` |
+          <details>
+          <summary><strong>Formatting Output</strong></summary>
+
+          \`\`\`diff
+          ${formatSummary}
+          \`\`\`
+          </details>
+
+          <details>
+          <summary><strong>Validation Output</strong></summary>
+
+          \`\`\`
+          ${{ steps.validate.outputs.stdout }}
+          \`\`\`
+          </details>`;
+
+          // If we have a comment, update it, otherwise create a new one.
+          if (botComment) {
+            github.rest.issues.updateComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              comment_id: botComment.id,
+              body: output,
+            });
+          } else {
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: output,
+            });
+          }
   tfsec:
     name: Scan Terraform code for security vulnerabilities
     needs: terraform
@@ -68,8 +147,8 @@ jobs:
     - uses: aquasecurity/[email protected]
       with:
         github_token: ${{ github.token }}
-  yamllint:
-    name: Lint YAML documents
+  yaml-style:
+    name: Check YAML style
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
@@ -78,5 +157,5 @@ jobs:
         python-version: "3.10"
     - name: Install yamllint
       run: pip install --user yamllint
-    - name: Lint
+    - name: Validate YAML
       run: yamllint .

.gitignore

@@ -1,6 +1,9 @@
 # Local .terraform directories
 **/.terraform/*
 
+# Terraform lock file
+.terraform.lock.hcl
+
 # .tfstate files
 *.tfstate
 *.tfstate.*

.markdownlint.jsonc

@@ -0,0 +1,6 @@
+{
+  "default": true,
+  "line-length": {
+    "tables": false
+  }
+}

CODE_OF_CONDUCT.md

@@ -5,30 +5,30 @@
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
 ## Our Standards
 
 Examples of behaviour that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behaviour by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -37,11 +37,11 @@ Project maintainers are responsible for clarifying the standards of acceptable
 behaviour and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behaviour.
 
-Project maintainers 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, or to ban temporarily or
-permanently any contributor for other behaviours that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers 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, or to ban temporarily or permanently any
+contributor for other behaviours that they deem inappropriate, threatening,
+offensive, or harmful.
 
 ## Scope
 
@@ -55,20 +55,21 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behaviour may be
-reported by contacting the project team at [email protected]. All
+reported by contacting the [project team](mailto:[email protected]). All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+obligated to maintain confidentiality with regard to the reporter of an
+incident.  Further details of specific enforcement policies may be posted
+separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -33,7 +33,8 @@ will be run to ensure changes do not break current functionality.
 Changes are more likely to be approve if they:
 
 - Include tests for new functionality,
-- Are accompanied with a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
+- Are accompanied with a [good commit
+  message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
 - Contain few commits (preferably a single commit),
 - Do not contain merge commits,
 - Maintain backward compatibility.

LICENSE.md renamed to LICENSE

@@ -0,0 +1,44 @@
+SHELL := bash
+.ONESHELL:
+.SHELLFLAGS := -eu -o pipefail -c
+.DEFAULT_GOAL := check
+.DELETE_ON_ERROR:
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rules
+TERRAFORM := terraform
+
+ifeq ($(origin .RECIPEPREFIX), undefined)
+  $(error This Make does not support .RECIPEPREFIX. Please use GNU Make 4.0 or later)
+endif
+.RECIPEPREFIX =
+
+.PHONY: help
+help:
+	@echo "Usage: make <target>"
+	@echo
+	@echo "Targets:"
+	@echo "  init     Initialize the Terraform working directory"
+	@echo "  check    Check if the configuration is well formatted (default)"
+	@echo "  format   Format the configuration"
+	@echo "  validate Validate the configuration"
+	@echo "  clean    Clean the Terraform working directory"
+
+.PHONY: init
+init:
+	$(TERRAFORM) init -backend=false
+
+.PHONY: check
+check:
+	$(TERRAFORM) fmt -check -recursive
+
+.PHONY: format
+format:
+	$(TERRAFORM) fmt -recursive
+
+.PHONY: validate
+validate: init
+	$(TERRAFORM) validate
+
+.PHONY: clean
+clean:
+	@rm -rf .terraform