docs: update docs for tf and ci

[saidsef]

Closes: #43

[saidsef]

/code pr

[saidsef]

🤖

Review of Commit 3546911

.gitlab-ci.yml

• Line 5-7: Addition of id_tokens block is correct and aligns with the deprecation notice for CI_JOB_JWT_V2.
• Line 16: Update to use AWS_ID_TOKEN instead of CI_JOB_JWT_V2 is appropriate.
• Line 35: Changing the Terraform image to latest is generally good for getting the latest features, but it might introduce breaking changes. Consider pinning to a specific version if stability is a concern.

README.md

• Line 51: Adding a note about the deprecation of CI_JOB_JWT and CI_JOB_JWT_V2 is helpful.
• Line 55: Introduction of the "ID Tokens" section is clear and necessary.

TERRAFORM.md

• Line 5: Changing the Terraform version requirement to >= 1.0.0 is a good update for broader compatibility.
• Line 17: Correcting the type of force_detach_policies from string to bool is accurate.
• Line 47-50: Adding periods to descriptions improves readability.

examples/complete/README.md

• Line 29-32: Correcting the type of force_detach_policies from string to bool is accurate.
• Line 33: Removing the default value for gitlab_organisation and making it required is a good practice.
• Line 41-42: Adding periods to descriptions improves readability.

examples/complete/variables.tf

• Line 1-6: Moving region variable to the end and adding validation is a good practice.
• Line 25: Correcting the type of force_detach_policies from string to bool is accurate.
• Line 29: Adding validation for gitlab_organisation is a good practice.
• Line 51: Adding validation for gitlab_repositories is a good practice.
• Line 61: Adding validation for iam_role_name is a good practice.
• Line 75: Adding validation for iam_role_path is a good practice.
• Line 113: Adding validation for url is a good practice.

examples/remote/main.tf

• Line 17: Changing branches to refs and adding ref_type is correct and aligns with the updated variable definition.

outputs.tf

• Line 4, 9, 14, 19: Adding periods to descriptions improves readability.

variables.tf

• Line 25: Correcting the type of force_detach_policies from string to bool is accurate.
• Line 29: Adding validation for gitlab_organisation is a good practice.
• Line 52: Adding validation for gitlab_repositories is a good practice.
• Line 62: Adding validation for iam_role_name is a good practice.
• Line 75: Adding validation for iam_role_path is a good practice.
• Line 113: Adding validation for url is a good practice.

Review of Commit 7daf2b4

README.md

• Line 51: Changing the link format to angle brackets is a minor but good readability improvement.
• Line 59: Adding a link to the updated .gitlab-ci.yml for ID tokens is helpful.

Summary

The changes are well-structured and improve the codebase by updating deprecated features, adding necessary validations, and enhancing documentation. The only potential issue is the use of latest for the Terraform image, which could introduce instability. Consider pinning to a specific version if stability is a priority.

_{> gpt-4o [pr | 1]}