From 734cc840b0f756b751e19709ddd0e949c3575676 Mon Sep 17 00:00:00 2001 From: badra001 Date: Tue, 27 May 2025 12:18:39 -0400 Subject: [PATCH] create/copy issue and MR templates --- .gitlab/CODEOWNERS | 1 + .gitlab/issue_templates/bug_report.md | 32 ++++++++++++++++ .gitlab/merge_request_templates/main.md | 49 +++++++++++++++++++++++++ 3 files changed, 82 insertions(+) create mode 100644 .gitlab/CODEOWNERS create mode 100644 .gitlab/issue_templates/bug_report.md create mode 100644 .gitlab/merge_request_templates/main.md diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS new file mode 100644 index 00000000..f3f5eea9 --- /dev/null +++ b/.gitlab/CODEOWNERS @@ -0,0 +1 @@ +/aws/info/ @terraform/reviewers-accounts diff --git a/.gitlab/issue_templates/bug_report.md b/.gitlab/issue_templates/bug_report.md new file mode 100644 index 00000000..e9b2d692 --- /dev/null +++ b/.gitlab/issue_templates/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Identify Environment** + - Terraform version [`terraform -version`]: + - Repository [`git remote -v show`]: + - Git branch [`git branch`]: + - Current working directory [`pwd`]: + - Commands issued + - Errors generated + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add pasted text output from terraform plan or apply (or a screenshot, but text is preferred) to help explain your problem. + +**Server (please complete the following information):** + - Hostname [e.g. redwood.cto.census.gov] + - OS Version [e.g. RHEL6, RHEL7] + +**Additional context** +Add any other context about the problem here. diff --git a/.gitlab/merge_request_templates/main.md b/.gitlab/merge_request_templates/main.md new file mode 100644 index 00000000..690beddb --- /dev/null +++ b/.gitlab/merge_request_templates/main.md @@ -0,0 +1,49 @@ + + + + +## Description + + +## Purpose + + + + +## Add tf-plan output Here +- Upload the unedited `tf-plan` log (found with: ls logs/plan.*.log | tail -n 1) as markdown with syntax highlighting using `console`. +- If the plan is long, also paste here a plan summary from `tf-plan summary` +- Be sure to user markdown syntax highlighthing for script + +## Screenshots (if appropriate): + + + +## Requirements +- Testing + 1. Be sure you have a successful ouput from `tf-plan`, and if necessary for a multi-step configuration, `tf-plan -target=...`. + 1. Post (append) the `tf-plan` log + 1. Commit/Push/PR before applying + +- Environment Checks + + 1. Make sure `remote_state.yml` is accurate + 1. Setup: `tf-directory-setup.py -l none` + 1. Setup: setup-new-directory.sh + 1. Make sure to have run `tf-directory-setup.py -l s3' after applying and then PR again to get the link + +- Code Checks + 1. No hardcoded resource values (i.e., vpc_id = "vpc-12345678") + 1. Proper case and no spaces in Tags + 1. Resource have tags if they support them + 1. `variables` definitions include `description` and `type` + 1. Run `tf-fmt` to format the code + 1. Run `terraform-docs .` to generate updated README.md + +- Include Documentation + 1. Be sure to have copied documentation referenced [here](https://gitlab.e.it.census.gov/terraform/support/blob/master/docs/app-setup.md) and populated + - [terraform-docs.yml](https://gitlab.e.it.census.gov/terraform/support/blob/master/docs/app-setup/.terraform-docs.yml) + - [README.md](https://gitlab.e.it.census.gov/terraform/support/blob/master/docs/app-setup/README.md.example) + 1. Include Remedy ticket numbers, CRF links, contact names, and a description in the README.md. + +