Add new `Terraform-Module.gitlab-ci.yml` CI/CD template
What does this MR do and why?
This change set introduces a new CI/CD template named
Terraform-Module.gitlab-ci.yml
which can be used to easily deploy a
Terraform Module to the GitLab Terraform Registry.
Prior to this change the documentation contained a pipeline snippet which could be used to achieve the same. This is a little cumbersome for users though and it would be nice if that snippet would just exist as a template - that's what this MR does ;)
The template comes as a pipeline and job template which makes it easy to adapt to more complex use-cases like deploying multiple Terraform Modules from the same pipeline.
This change set also contains the relevant new template metrics and specs for the new templates.
Screenshots or screen recordings
Aspect | Reference |
---|---|
New template can be selected in UI | ![]() |
Regular branch pipeline | https://gitlab.com/timofurrer/terraform-pet-site-module-template/-/pipelines/761336962 |
Tag pipeline | https://gitlab.com/timofurrer/terraform-pet-site-module-template/-/pipelines/761337414 |
How to set up and validate locally
- Create a new project
- Create a new
.gitlab-ci.yml
using WebIDE - Create from
Terraform-Module
template - Run branch pipelines and verify
- Run tag pipelines and verify
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Merge request reports
Activity
assigned to @timofurrer
mentioned in commit 8b7ca372
added 1 commit
- 8b7ca372 - Add new `Terraform-Module.gitlab-ci.yml` CI/CD template
- A deleted user
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Hordur Freyr Yngvason
2 Warnings e798123a: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. For the following files, a review from the Data team and Product Intelligence team is recommended
Please check the product intelligence Service Ping guide or the Snowplow guide.For MR review guidelines, see the Service Ping review guidelines or the Snowplow review guidelines.
config/metrics/counts_28d/20230130074932_p_ci_templates_terraform_module_monthly.yml
config/metrics/counts_28d/20230130075614_p_ci_templates_terraform_module_base_monthly.yml
config/metrics/counts_7d/20230130074931_p_ci_templates_terraform_module_weekly.yml
config/metrics/counts_7d/20230130075613_p_ci_templates_terraform_module_base_weekly.yml
config/metrics/counts_28d/20210216184559_ci_templates_total_unique_counts_monthly.yml
config/metrics/counts_7d/20210216184557_ci_templates_total_unique_counts_weekly.yml
lib/gitlab/usage_data_counters/known_events/ci_templates.yml
2 Messages This merge request adds or changes files that require a review from the CI/CD Templates maintainers. This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. This merge request requires a CI/CD Template review. To make sure these changes are reviewed, take the following steps:
- Ensure the merge request has the citemplates label. If the merge request modifies CI/CD Template files, Danger will do this for you.
- Prepare your MR for a CI/CD Template review according to the template development guide.
- Assign and
@
mention the CI/CD Template reviewer suggested by Reviewer Roulette.
The following files require a review from the CI/CD Templates maintainers:
lib/gitlab/ci/templates/Terraform/Module-Base.gitlab-ci.yml
lib/gitlab/ci/templates/Terraform-Module.gitlab-ci.yml
Documentation review
The following files require a review from a technical writer:
-
doc/user/packages/terraform_module_registry/index.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
Reviewer roulette
Changes that require review have been detected!
Please refer to the table below for assigning reviewers and maintainers suggested by Danger in the specified category:
Category Reviewer Maintainer backend Gregory Havenga (
@ghavenga
) (UTC+2, 1 hour ahead of@timofurrer
)Matthias Käppler (
@mkaeppler
) (UTC+1, same timezone as@timofurrer
)citemplates Sean Arnold (
@seanarnold
) (UTC+13, 12 hours ahead of@timofurrer
)Lucas Charles (
@theoretick
) (UTC-8, 9 hours behind@timofurrer
)product intelligence Piotr Skorupa (
@pskorupa
) (UTC+1, same timezone as@timofurrer
)Maintainer review is optional for product intelligence To spread load more evenly across eligible reviewers, Danger has picked a candidate for each review slot, based on their timezone. Feel free to override these selections if you think someone else would be better-suited or use the GitLab Review Workload Dashboard to find other available reviewers.
To read more on how to use the reviewer roulette, please take a look at the Engineering workflow and code review guidelines. Please consider assigning a reviewer or maintainer who is a domain expert in the area of the merge request.
Once you've decided who will review this merge request, assign them as a reviewer! Danger does not automatically notify them for you.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger
- Resolved by 🤖 GitLab Bot 🤖
Proper labels assigned to this merge request. Please ignore me.
@timofurrer - please see the following guidance and update this merge request.1 Error Please add typebug typefeature, or typemaintenance label to this merge request. Edited by 🤖 GitLab Bot 🤖
- A deleted user
mentioned in commit 24b56ec3
marked the checklist item I have evaluated the MR acceptance checklist for this MR. as completed
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
mentioned in commit b0da79eb
added grouppackage registry label
added devopspackage sectionops labels
added workflowready for review label
requested review from @abdwdd, @seanarnold, and @michold
requested review from @tigerwnz and @phillipwells and removed review request for @abdwdd
@abdwdd
, thanks for approving this merge request.This is the first time the merge request is approved. To ensure full test coverage, a new pipeline will be started shortly.
For more info, please refer to the following links:
added pipeline:mr-approved label
mentioned in issue gitlab-com/www-gitlab-com#13444 (closed)
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
- Resolved by Timo Furrer
@timofurrer Left you a few comments on the docs updates.
(cc @claytoncornell, since this touches a page in grouppackage registry).
changed milestone to %15.9
added Technical Writing docsfeature labels
- Resolved by Timo Furrer
The template file looks good, verified in my own project.
- Resolved by Tiger Watson
removed review request for @tigerwnz
mentioned in commit f4b9665f
added 1 commit
- f4b9665f - Add new `Terraform-Module.gitlab-ci.yml` CI/CD template
mentioned in commit 61bea1d8
added 1 commit
- 61bea1d8 - Add new `Terraform-Module.gitlab-ci.yml` CI/CD template
- Resolved by Tiger Watson
mentioned in merge request !66924 (closed)
mentioned in commit 4d9582b6
mentioned in commit 9fcafc61
added 224 commits
-
4d9582b6...7c46dd1f - 222 commits from branch
master
- c8098e8c - Add metrics for new Terraform-Module ci templates
- 9fcafc61 - Add new `Terraform-Module.gitlab-ci.yml` CI/CD template
-
4d9582b6...7c46dd1f - 222 commits from branch
- Resolved by Timo Furrer
added workflowin review label and removed workflowready for review label
mentioned in commit 1b9c80dc
added 1 commit
- 1b9c80dc - Add new `Terraform-Module.gitlab-ci.yml` CI/CD template
mentioned in commit cabca64f
mentioned in commit 4eebf104
removed review request for @phillipwells
added 1 commit
- 0124b3cd - Manually update known_events/ci_templates.yaml
removed review request for @seanarnold
requested review from @pskorupa
removed review request for @pskorupa
mentioned in commit ece7aec6
added 368 commits
-
0124b3cd...edde6971 - 365 commits from branch
master
- 2c133b3f - Add metrics for new Terraform-Module ci templates
- ece7aec6 - Add new `Terraform-Module.gitlab-ci.yml` CI/CD template
- c907fc02 - Manually update known_events/ci_templates.yaml
Toggle commit list-
0124b3cd...edde6971 - 365 commits from branch
removed review request for @michold
requested review from @hfyngvason
- Resolved by Timo Furrer
- Resolved by Hordur Freyr Yngvason
Thanks @timofurrer! This looks great! Just one small question from me. Let me know what you think
removed review request for @hfyngvason
mentioned in commit 939ff82b
added 188 commits
-
c907fc02...47a9ca14 - 184 commits from branch
master
- e798123a - Add metrics for new Terraform-Module ci templates
- 939ff82b - Add new `Terraform-Module.gitlab-ci.yml` CI/CD template
- c1a7afdb - Manually update known_events/ci_templates.yaml
- 8055401e - Use terraform-images for Terraform Module CI/CD template
Toggle commit list-
c907fc02...47a9ca14 - 184 commits from branch
mentioned in issue terraform-images#100
requested review from @michold
added product intelligenceapproved label and removed product intelligencereview pending label
removed review request for @michold
requested review from @hfyngvason
@hfyngvason, did you forget to run a pipeline before you merged this work? Based on our code review process, if the latest pipeline was created more than 6 hours ago, and finished more than 2 hours ago, you should:
- Ensure the merge request is not in Draft status.
- Start a pipeline (especially important for Community contribution merge requests).
- Set the merge request to merge when pipeline succeeds.
This is a guideline, not a rule. Please consider replying to this comment for transparency.
This message was generated automatically. You're welcome to improve it.
mentioned in commit 13dd2db7
mentioned in commit 93c605c7
added workflowstaging-canary label and removed workflowin review label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added releasedcandidate label
mentioned in merge request gitlab-com/www-gitlab-com!119733 (merged)
mentioned in merge request kubitus-project/kubitus-installer!1922 (merged)
added releasedpublished label and removed releasedcandidate label
mentioned in issue timofurrer/growth-and-development#33 (closed)