Skip to content

Commit

Permalink
feat: todo title (#8)
Browse files Browse the repository at this point in the history
* chore: `CODEOWNERS` file
* chore: issue templates
* chore: pull request template
* refactor: simplifying structure
  • Loading branch information
caerulescens authored Oct 5, 2024
1 parent 1935bf7 commit e15f550
Show file tree
Hide file tree
Showing 16 changed files with 236 additions and 90 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @caerulescens
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/1-FEATURE-REQUEST.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: "💡 Feature Request"
description: "Create a new ticket for a new feature request."
title: "feat: <title>"
labels:
- "enhancement"
assignees:
- "caerulescens"
body:
# Feature
- type: textarea
id: summary
attributes:
label: "Summary"
description: What feature would you like to add?
placeholder: ...
validations:
required: true

# Implementation
- type: textarea
id: implementation
attributes:
label: "Implementation"
description: How would the feature work in more detail?
placeholder: ...
validations:
required: true

# Drawbacks
- type: textarea
id: drawback
attributes:
label: "Drawbacks"
description: What drawbacks does this feature have?
placeholder: ...
validations:
required: false

# Questions
- type: textarea
id: question
attributes:
label: "Questions"
description: Are there any unsolved question related to the feature?
placeholder: ...
validations:
required: false
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/2-BUG-REPORT.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: "🐞 Bug Report"
description: "Create a new issue for a bug."
title: "fix: <title>"
labels:
- "bug"
assignees:
- "caerulescens"
body:
# Version
- type: textarea
id: version
attributes:
label: "Version"
description: Which version were you running?
placeholder: e.g. '0.1.0'
validations:
required: true

# Terragrunt Version
- type: textarea
id: terragrunt-version
attributes:
label: "Terragrunt version"
description: Which terragrunt version were you using?
placeholder: e.g. '0.67.16'
validations:
required: true

# Tofu Version
- type: textarea
id: tofu-version
attributes:
label: "Tofu version"
description: Which tofu version were you using?
placeholder: e.g. '1.8.3'
validations:
required: true

# Operating System
- type: dropdown
id: operating-system
attributes:
label: "Operating system"
description: Which operating system were you using?
multiple: false
options:
- Windows
- macOS
- GNU/Linux
validations:
required: true

# Description
- type: textarea
id: description
attributes:
label: "Description"
description: Provide details of the issue you encountered
placeholder: ...
validations:
required: true

# Reproduction
- type: textarea
id: reproduction
attributes:
label: "Reproduction"
description: Provide details on how to reproduce the issue
placeholder: |
#. Use config '...'
#. Run program '...'
#. See error '...'
render: bash
validations:
required: true

# Screenshots
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: Provide any relevant screenshots
value: |
![DESCRIPTION](LINK.png)
render: bash
validations:
required: false

# Logs
- type: textarea
id: log
attributes:
label: "Logs"
description: Provide any raw log output
render: bash
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Title
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->

## Motivation and Context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## How has this been tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, tests ran to see how -->
<!--- your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
1 change: 0 additions & 1 deletion .terraform-version

This file was deleted.

65 changes: 45 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ A [`terragrunt`](https://github.com/gruntwork-io/terragrunt) module for [`miniku

## Install

| name |
|-----------------------------------------------------------|
| [docker](https://github.com/docker) |
| [minikube](https://github.com/kubernetes/minikube) |
| [kubectl](https://github.com/kubernetes/kubectl) |
| [terragrunt](https://github.com/gruntwork-io/terragrunt) |
| [terraform](https://github.com/hashicorp/terraform) |
| [opentofu](https://github.com/opentofu/opentofu) |
| [pre-commit](https://github.com/pre-commit/pre-commit) |
| Name |
|--------------------------------------------------------|
| [docker](https://github.com/docker) |
| [kubectl](https://github.com/kubernetes/kubectl) |
| [minikube](https://github.com/kubernetes/minikube) |
| [tenv](https://github.com/tofuutils/tenv) |
| [pre-commit](https://github.com/pre-commit/pre-commit) |

```shell
pre-commit install
Expand All @@ -22,28 +20,55 @@ pre-commit install

Configure:
```shell
cat <<EOF > live/minikube/local/dev/default/docker/terraform.tfvars
cat <<EOF > ./live/cluster/docker/terraform.tfvars
minikube_clusters = {
"minikube": {
"driver": "docker",
"nodes": 3,
"cpus": 4,
"memory": "4096mb"
"driver": "docker"
"nodes": 3
"cpus": 2
"memory": "2048mb"
"disk_size": "65536mb",
"extra_disks": 0
}
}
EOF
```

Create:
Validate:
```shell
terragrunt init --terragrunt-working-dir live/minikube/local/dev/default/docker
terragrunt plan --terragrunt-working-dir live/minikube/local/dev/default/docker
terragrunt apply --terragrunt-working-dir live/minikube/local/dev/default/docker
terragrunt validate-inputs --terragrunt-working-dir live/dev/cluster
```

Remove:
Init:
```shell
terragrunt destroy --terragrunt-working-dir live/minikube/local/dev/default/docker
terragrunt init --terragrunt-working-dir live/dev/cluster
```

Plan:
```shell
terragrunt plan --terragrunt-working-dir live/dev/cluster
```

Apply:
```shell
terragrunt apply --terragrunt-working-dir live/dev/cluster
```

Destroy:
```shell
terragrunt destroy --terragrunt-working-dir live/dev/cluster
```

## Development

Validate:
```shell
terragrunt hclvalidate
```

Format:
```shell
terragrunt hclfmt
```

Check:
Expand Down
File renamed without changes.
14 changes: 14 additions & 0 deletions live/dev/cluster/terragrunt.hcl
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
include "root" {
path = find_in_parent_folders()
}

include "common" {
path = "${dirname(find_in_parent_folders())}/_common/minikube.hcl"
expose = true
}

terraform {
source = "${include.common.locals.base_source_url}?ref=${include.common.locals.ref}"
}

inputs = {}
21 changes: 0 additions & 21 deletions live/minikube/local/dev/default/docker/.terraform.lock.hcl

This file was deleted.

16 changes: 0 additions & 16 deletions live/minikube/local/dev/default/docker/terragrunt.hcl

This file was deleted.

3 changes: 0 additions & 3 deletions live/minikube/local/dev/default/profile.hcl

This file was deleted.

3 changes: 0 additions & 3 deletions live/minikube/local/dev/environment.hcl

This file was deleted.

3 changes: 0 additions & 3 deletions live/minikube/local/region.hcl

This file was deleted.

3 changes: 0 additions & 3 deletions live/minikube/platform.hcl

This file was deleted.

22 changes: 2 additions & 20 deletions live/terragrunt.hcl
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
locals {
# automatically load platform variables
platform_vars = read_terragrunt_config(find_in_parent_folders("platform.hcl"))
locals {}

# automatically load region variables
region_vars = read_terragrunt_config(find_in_parent_folders("region.hcl"))

# automatically load environment variables
environment_vars = read_terragrunt_config(find_in_parent_folders("environment.hcl"))

# automatically load environment variables
profile_vars = read_terragrunt_config(find_in_parent_folders("profile.hcl"))
}

# merge platform, region, environment, and profile vars
inputs = merge(
local.platform_vars.locals,
local.region_vars.locals,
local.environment_vars.locals,
local.profile_vars.locals
)
inputs = {}

0 comments on commit e15f550

Please sign in to comment.