https://github.com/hapag-lloyd/repository-template-terraform-module

Template repository for Terraform Module projects
https://github.com/hapag-lloyd/repository-template-terraform-module

repository setup template terraform-module

Last synced: 29 days ago
JSON representation

Template repository for Terraform Module projects

• Host: GitHub
• URL: https://github.com/hapag-lloyd/repository-template-terraform-module
• Owner: Hapag-Lloyd
• License: mit
• Created: 2024-05-06T15:08:04.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-08T22:53:28.000Z (30 days ago)
• Last Synced: 2024-10-10T07:01:54.912Z (29 days ago)
• Topics: repository, setup, template, terraform-module
• Language: HCL
• Homepage:
• Size: 33.2 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Repository-Template-Terraform-Module

Template repository for Terraform Module projects. It uses a manual release process which automatically creates a PR for a release

but you have to merge this PR manually.

Don't forget to update the README.md file with the project information and initially run

```shell

git checkout main

.github/update_templates.sh

# strongly suggested!

pre-commit install -c .github/pre-commit-config.yaml

```

In case a major release is published on the Workflow-Template repository, run `.github/update_workflows.sh`. This creates a PR

with the changes in the workflows. Carefully check the changes and merge them into the `main` branch.

You have to setup the [Terraform Registry](https://registry.terraform.io/) by your own, e.g. register the module and setup the

webhook in the repository.

## Development

### Usage

This repository is used as a template repository for new Terraform Module projects. Thus the newly created repository will have the

same structure and configurations as this one.

After merging into the `main` branch, use `.github/update_init_branches.sh` to merge these changes into the `init-` branches as

well.

### `init-` branches

The `init-` branches are used to initialize the project with the necessary files and configurations. Create them in this repository

and add a `pr-description.md` file with the description of the changes to be made. The first line contains the title of the PR

followed by a blank line and then the description.

Never merge these branches directly into the `main` branch.