chore: use templates from default repository (#313)

This PR syncs all templates from the default
`Repository-Template-Terraform-Module.`

---------

Co-authored-by: Pascal Frenz <[email protected]>

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+see CODEOWNERS.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contribution guide
+
+We appreciate your thought to contribute to open source. :heart: We want to make contributing as easy as possible. You are welcome to:
+
+- Report a bug
+- Discuss the current state of the code
+- Submit a fix
+- Propose new features
+
+We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull
+requests. We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code, check one of the examples.
+3. Make sure your code lints.
+4. Raise a pull request.
+
+## Documentation
+
+We use [pre-commit](https://pre-commit.com/) for some default checks which are fast and find the most common errors.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the license available at
+[LICENSE](blob/main/LICENSE).

.github/pull_request_template.md

@@ -12,8 +12,7 @@ no: please delete the whole paragraph
 
 # Verification
 
-Please mention the examples you have verified.
-Did you check the change in your environment?
+Please describe the test cases you used to verify your code. Did you check the change in your environment?
 
 # Checklist
 

.github/update_init_branches.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+#
+# This script rebases all init branches on the main branch.
+#
+
+git checkout main
+git pull
+
+# for all init branches
+for branch in $(git branch --list "init-*"); do
+  git checkout "$branch"
+  git merge main
+  git push
+done

.github/update_templates.sh

@@ -0,0 +1,109 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+#
+# This script updates the current repository with the latest version of the templates. It creates a new branch and a pull request.
+#
+
+function ensure_dependencies_or_exit() {
+  if ! command -v gh &> /dev/null; then
+    echo "gh is not installed. Please install it from https://cli.github.com/"
+    exit 1
+  fi
+}
+
+function ensure_repo_preconditions_or_exit() {
+  # ensure main branch
+  if [ "$(git branch --show-current)" != "main" ]; then
+    echo "The current branch is not main. Please switch to the main branch."
+    exit 1
+  fi
+
+  # ensure a clean working directory
+  if [ -n "$(git status --porcelain)" ]; then
+    echo "The working directory is not clean. Please use a clean copy so no unintended changes are merged."
+    exit 1
+  fi
+}
+
+function create_and_show_pr_for_init_branch() {
+  local branch_name=$1
+
+  if git branch | grep -q "$branch_name"; then
+    git checkout "$branch_name"
+
+    title=$(head -n1 pr-description.md)
+    body=$(tail -n2 pr-description.md)
+
+    rm pr-description.md
+    git add .
+    git commit -m "remove the PR description"
+    git push
+
+    gh pr create --title "$title" --body "$body" --base main --head "$branch_name"
+    gh pr view --web
+  fi
+}
+
+ensure_dependencies_or_exit
+ensure_repo_preconditions_or_exit
+
+latest_template_path=$(mktemp -d -t repository-template-XXXXX)
+new_branch_name=$(basename "$latest_template_path")
+
+# clone the default branch to get the latest version of the template files
+gh repo clone https://github.com/Hapag-Lloyd/Repository-Template-Terraform-Module.git "$latest_template_path"
+
+# create a new branch to update the templates
+git checkout -b "$new_branch_name"
+
+# update issue templates
+cp -r "$latest_template_path/.github/ISSUE_TEMPLATE" .github/
+
+# update pull request template
+cp "$latest_template_path/.github/PULL_REQUEST_TEMPLATE.md" .github/
+
+# update contributing guidelines
+cp "$latest_template_path/.github/CONTRIBUTING.md" .github/
+
+# update the update scripts
+cp "$latest_template_path/.github"/update_*.sh .github/
+
+# create a commit, push it and open a pull request
+git add .github
+git commit -m "chore: update project templates"
+git push --set-upstream origin "$new_branch_name"
+
+gh pr create --title "chore: update project templates" --body "This PR updates the project templates." --base main --head "$new_branch_name"
+
+echo "The project templates have been updated. Please review and merge the pull request."
+gh pr view --web
+
+# create PR to initialize the CODEOWNERS file
+branch_name="kayma/init-codeowners"
+
+if git branch | grep -q "$branch_name"; then
+  git checkout "$branch_name"
+
+  title=$(head -n1 pr-description.md)
+  body=$(tail -n2 pr-description.md)
+
+  rm pr-description.md
+  git add .
+  git commit -m "remove the PR description"
+  git push
+
+  gh pr create --title "$title" --body "$body" --base main --head "$branch_name"
+  gh pr view --web
+fi
+
+# initialize the LICENSE and CODEOWNERS file
+
+# find all init- branches
+init_branches=$(git branch | grep "init-")
+
+for init_branch in $init_branches; do
+  create_and_show_pr_for_init_branch "$init_branch"
+done
+
+rm -rf "$latest_template_path"

.github/update_workflows.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+#
+# This script updates the current repository with the latest version of the workflows. It creates a new branch and a pull request.
+#
+
+function ensure_dependencies_or_exit() {
+  if ! command -v gh &> /dev/null; then
+    echo "gh is not installed. Please install it from https://cli.github.com/"
+    exit 1
+  fi
+}
+
+function ensure_repo_preconditions_or_exit() {
+  # ensure main branch
+  if [ "$(git branch --show-current)" != "main" ]; then
+    echo "The current branch is not main. Please switch to the main branch."
+    exit 1
+  fi
+
+  # ensure a clean working directory
+  if [ -n "$(git status --porcelain)" ]; then
+    echo "The working directory is not clean. Please use a clean copy so no unintended changes are merged."
+    exit 1
+  fi
+}
+
+ensure_dependencies_or_exit
+ensure_repo_preconditions_or_exit
+
+current_directory=$(pwd)
+latest_workflows_path=$(mktemp -d -t repository-template-XXXXX)
+
+gh repo clone https://github.com/Hapag-Lloyd/Workflow-Templates.git "$latest_workflows_path"
+
+# update the workflows
+(
+  cd "$latest_workflows_path" || exit 7
+
+  ./update-workflows.sh "$current_directory" maven
+)
+
+rm -rf "$latest_workflows_path"