docs: added the genie repo - #21
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a Makefile and a README.yaml for the Terraform Azure Virtual Machine module. The review feedback suggests using $(CURDIR) in the Makefile for efficiency, correcting a repository name discrepancy, standardizing the spelling of "License", and updating the usage example to correctly reflect the module's functionality.
| @@ -0,0 +1,7 @@ | |||
| GENIE_PATH ?= $(shell pwd)/../../../genie | |||
There was a problem hiding this comment.
In GNU Make, it is generally preferred to use the built-in variable $(CURDIR) instead of calling the external pwd command via $(shell pwd). $(CURDIR) is more efficient as it does not require spawning a shell process.
GENIE_PATH ?= $(CURDIR)/../../../genie
| GENIE_PATH ?= $(shell pwd)/../../../genie | ||
|
|
||
| ifeq ($(wildcard $(GENIE_PATH)),) | ||
| GENIE_PATH := $(shell pwd)/genie |
There was a problem hiding this comment.
Consistent with the previous suggestion, use $(CURDIR) here as well to avoid unnecessary shell execution.
GENIE_PATH := $(CURDIR)/genie
|
|
||
| license: "APACHE" | ||
|
|
||
| github_repo: terraform-az-modules/terraform-azurerm-virtual-machine |
There was a problem hiding this comment.
There is a discrepancy between the repository name specified here (terraform-azurerm-virtual-machine) and the one defined in variables.tf (line 52: terraform-azure-virtual-machine). Please ensure they are consistent to avoid broken links or issues with automated documentation generation.
github_repo: terraform-az-modules/terraform-azure-virtual-machine| image: "https://img.shields.io/badge/Terraform-v1.10.0-green" | ||
| url: "https://www.terraform.io" | ||
|
|
||
| - name: "Licence" |
There was a problem hiding this comment.
The spelling 'Licence' (British English) is used here, while 'License' (American English) is used on line 11 and in the badge image URL on line 21. It is recommended to use consistent spelling throughout the document.
- name: "License"| module "resource_group" { | ||
| source = "terraform-az-modules/resource-group/azurerm" | ||
| version = "1.0.3" | ||
| name = "core" | ||
| environment = "dev" | ||
| location = "centralus" | ||
| label_order = ["name", "environment", "location"] |
There was a problem hiding this comment.
The usage example appears to be a placeholder from a template for a 'resource-group' module. It should be updated to demonstrate how to use the current 'virtual-machine' module.
module "virtual_machine" {
source = "terraform-az-modules/virtual-machine/azurerm"
version = "1.0.0"
name = "app"
environment = "dev"
location = "centralus"
label_order = ["name", "environment", "location"]
}
2 participants
Description
This pull request integrates Genie-based automation into the repository to standardize documentation generation and streamline development workflows.
What’s included:
Why this change:
Type of Change
Checklist