Docs #1
Merged
Docs #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduces a comprehensive docs/terraform.md explaining usage, configuration, and available Makefile targets for Terraform operations via Docker. Updates src/terraform.mk to declare all relevant .PHONY targets and clarifies that 'terraform state push' is not implemented yet.
Renamed the workflow file from git-release.yaml to release.yaml for improved clarity and consistency in workflow naming.
Created a README.md file in the examples/terraform directory with an initial header.
Introduces a new GitHub Actions workflow for linting using super-linter. Also adds a name to the release workflow for better identification.
The linting GitHub Actions workflow will no longer run on pull request events, only on push events.
This commit updates markdown files, issue templates, and configuration files to use consistent formatting (e.g., list styles, indentation, and quotes), corrects minor typos (such as 'lattest' to 'latest' in Dockerfile), and improves clarity in documentation. No functional changes to code or logic were made.
Standardized terminology in documentation and templates, such as changing 'git' to 'Git', 'e-mail' to 'email', and 'lock files' to 'lockfiles'. Improved consistency and clarity across README, issue template, code of conduct, and Terraform docs.
Improved link formatting and consistency in CODE_OF_CONDUCT.md and CONTRIBUTING.md. Updated markdown syntax for links and lists to enhance readability and maintain uniform style.
Removed trailing whitespace in CODE_OF_CONDUCT.md and corrected indentation in code blocks in CONTRIBUTING.md for improved readability and consistency.
Added 'required_version = "~> 1.0"' to main.tf files in custom-image, explicit-directory/dev, explicit-directory/prod, and wildcard example directories to enforce Terraform version compatibility.
Replaced inline Makefile setup instructions in README.md with a reference to a new examples/init.mk file. This improves clarity and maintainability by separating example code from documentation.
Explicitly set python3 to 3.12.11-r0 and py3-pip to 25.1.1-r0 in the custom Terraform image to ensure consistent builds and avoid unexpected version changes.
Added comments to skip Checkov checks CKV_DOCKER_3 and CKV_DOCKER_2 in the custom-image Dockerfile to bypass user creation and healthcheck requirements.
Added 'contents: read' under permissions in the GitHub Actions linting workflow to ensure proper access control during workflow execution.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request
Please provide a brief description of your changes below.
Description
Checklist
Additional notes