Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mvprowess authored Nov 18, 2024
0 parents commit d4be7e2
Show file tree
Hide file tree
Showing 21 changed files with 716 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .github/AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# This is the list of GOpsKit's significant contributors.
#
# This does not necessarily list everyone who has contributed code,
# especially since many employees of one corporation may be contributing.
# To see the full list of contributors, see the revision history in
# source control.
# This file is currently manually managed.

FMJ Studios
FMJdev
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# As the admin and steward of the project, FMJdev "owns" all code
* @FMJdev
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Copyright FMJ Studios
# SPDX-License-Identifier: MIT

name: 🐞 Bug
description: Create a report to help us improve
labels: ["tech-issues"]
body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue. Before you open the bug report please review the following troubleshooting
guide written by the folks at Terraform (HashCorp), which details the troubleshooting workflow for Terraform:
- [Troubleshoot Terraform](https://developer.hashicorp.com/terraform/tutorials/configuration-language/troubleshooting-workflow)
Please fill in as much of the following form as you're able.
- type: input
attributes:
label: Name and Version
description: Name and version of the affected (sub-)module
placeholder: vpc - v1.2.3
validations:
required: true
- type: input
attributes:
label: What Terraform version are you using?
description: Provide the version of your Terraform executable (output of `terraform version`)
placeholder: v1.9.6
- type: textarea
attributes:
label: What steps will reproduce the bug?
description: Enter details about your bug.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true
- type: textarea
attributes:
label: What is the expected behavior?
description: If possible please provide textual output instead of screenshots.
- type: textarea
attributes:
label: What do you see instead?
description: If possible please provide textual output instead of screenshots.
validations:
required: true
- type: textarea
attributes:
label: Additional information
description: Tell us anything else you think we should know.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Copyright FMJ Studios
# SPDX-License-Identifier: MIT

blank_issues_enabled: false
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Copyright FMJ Studios
# SPDX-License-Identifier: MIT

name: "\U0001F680 Feature request"
description: Suggest an idea for this project
labels: ["feature-request"]
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an idea to improve our Terraform modules.
Please fill in as much of the following form as you're able.
- type: input
attributes:
label: Name and Version
description: Name and version of the affected (sub-)module
placeholder: vpc - v1.2.3
validations:
required: true
- type: textarea
attributes:
label: What is the problem this feature will solve?
validations:
required: true
- type: textarea
attributes:
label: What is the feature you are proposing to solve the problem?
description: Describe the requests. If you already have something in mind... PRs are welcome!
validations:
required: true
- type: textarea
attributes:
label: What alternatives have you considered?
11 changes: 11 additions & 0 deletions .github/linters/.checkov.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
skip-check:
# Terraform module sources do not use a git url with a commit hash revision
# ref: https://docs.prismacloud.io/en/enterprise-edition/policy-reference/supply-chain-policies/terraform-policies/ensure-terraform-module-sources-use-git-url-with-commit-hash-revision
- CKV_TF_1

# Terraform module sources do not use a git url with a tag or commit hash revision
# ref: https://docs.prismacloud.io/en/enterprise-edition/policy-reference/supply-chain-policies/terraform-policies/ensure-terraform-module-sources-use-tag
- CKV_TF_2

skip-path:
- /examples
36 changes: 36 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Markdownlint configuration file
# ref: https://github.com/DavidAnson/markdownlint/blob/b2305efafb034b1f328845aec9928b5363ffd646/schema/.markdownlint.yaml

# MD012/no-multiple-blanks : Multiple consecutive blank lines : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md012.md
MD012:
# Consecutive blank lines
maximum: 3

# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
MD013:
# Number of characters
line_length: 240
# Number of characters for headings
heading_line_length: 350
# Number of characters for code blocks
code_block_line_length: 120
# Include code blocks
code_blocks: true
# Include headings
headings: true
# Exclude Tables
tables: false

# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
MD033:
# Allowed elements
allowed_elements: ["img", "a"]

# MD034/no-bare-urls : Bare URL used : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md034.md
# NOTE: disabled because the tables in the READMEs might contain chart values which are bare URLs
MD034: false

# MD036/no-emphasis-as-heading : Emphasis used instead of a heading : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md036.md
MD036:
# Punctuation characters
punctuation: ".,;:!?。,;:!?"
36 changes: 36 additions & 0 deletions .github/linters/.terraform-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
formatter: "markdown table" # required

version: ">= 0.13.0, < 1.0.0"

sections:
hide:
- requirements
- resources
- data-sources

output:
file: "README.md"
mode: inject
template: |-
<!-- BEGIN_TF_DOCS -->
{{ .Content }}
<!-- END_TF_DOCS -->
sort:
enabled: true
by: name

settings:
anchor: true
color: true
default: true
description: false
escape: true
hide-empty: false
html: false
indent: 2
lockfile: true
read-comments: true
required: true
sensitive: true
type: true
2 changes: 2 additions & 0 deletions .github/linters/typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[default.extend-words]
hel = "hel" # do not correct the 'hel' designation the Helsinki datacenter
43 changes: 43 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: "Release"

on:
workflow_dispatch:
repository_dispatch:
types: [release]
pull_request:
branches:
- "main"

permissions:
contents: write
pull-requests: write

defaults:
run:
shell: bash

concurrency:
group: "${{ github.workflow }}@${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"

jobs:
release:
runs-on: ubuntu-latest
env:
GH_TOKEN: ${{ secrets.ACCESS_TOKEN }}
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Semantic Release
uses: cycjimmy/semantic-release-action@v4
with:
semantic_version: 24
branches: |
[
'main',
'next'
]
extra_plugins: |
@semantic-release/changelog@6.0.3
@semantic-release/git@10.0.1
conventional-changelog-conventionalcommits@8.0.0
32 changes: 32 additions & 0 deletions .github/workflows/stale.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: "Close stale Issues & Pull Requests"

on:
schedule:
- cron: "30 18 * * 0"
workflow_dispatch:

permissions:
issues: write
pull-requests: write

jobs:
stale:
name: Mark issues and PRs as stale
runs-on: ubuntu-latest
steps:
- uses: actions/stale@v9
with:
# see https://github.com/actions/stale#all-options
repo-token: ${{ secrets.GITHUB_TOKEN }}
close-issue-label: "'This issue has been automatically closed because it has not had recent activity."
close-issue-message: false
close-pr-label: "'This PR has been automatically closed because it has not had recent activity."
close-pr-message: false
days-before-stale: 30
days-before-close: 60
exempt-issue-labels: pinned, security
exempt-pr-labels: pinned, security
stale-issue-label: stale
stale-issue-message: "This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
stale-pr-label: stale
stale-pr-message: "This PR has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions."
33 changes: 33 additions & 0 deletions .github/workflows/superlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "Run Super-Linter"

on: ["push", "pull_request"]

permissions: read-all

jobs:
lint:
name: Super-Lint
runs-on: ubuntu-latest
permissions:
contents: read
packages: read
statuses: write
steps:
- name: Checkout
uses: actions/checkout@v4
with:
# super-linter needs the full git history to get the
# list of files that changed across commits
fetch-depth: 0

- name: Superlinter
uses: super-linter/super-linter@v7.1.0
env:
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
FILTER_REGEX_EXCLUDE: (CHANGELOG.md)
# mostly false positives
VALIDATE_NATURAL_LANGUAGE: false
# no support for preconditions in lifecycles
# ref: https://github.com/tenable/terrascan/issues/1642
VALIDATE_TERRAFORM_TERRASCAN: false
Loading

0 comments on commit d4be7e2

Please # to comment.