update documentation & fix bug with release drafter no releases for changes to the gitignore (#109)

Author: marwinbaumannsbp

.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+default_stages: [pre-commit]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-json
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files

README.md

@@ -1,27 +1,67 @@
 # mcaf-github-workflows
 
-Repository for centralized reusable Github workflows.
+Repository to synchronize GitHub workflows and repository files.
 
-## Create workflows
+## Adding Repositories
 
-Create or modify a yaml file in [.github/workflows/](.github/workflows/). Also update README.md with details about your workflow and remember that this is a public repository.
+To add your repository to the sync:
 
-Push your changes to a branch. Once you are done with all your changes, open a PR.
+- Add your repository to  `REPOSITORIES` in the YAML file: `.github/workflows/workflow-synchronization.yaml`.
+
+## Updating & Creating Workflows
+
+To create or modify a workflow:
+
+- Add or update a YAML file in the [`.github/workflows/`](.github/workflows/) directory.
+- Update the `README.md` with details about your workflow.
+- Ensure that your changes align with best practices and repository conventions.
+- Push your changes to a branch and open a Pull Request (PR) once all modifications are complete.
 
 ## Workflows
 
+### Label Synchronization
+
+Ensures that the repository contains the required GitHub labels.
+
 ### PR Validation
 
-Verifies the PR has the required labels and proper title set.
+Verifies that a PR has the required labels and a properly formatted title before merging.
 
 ### Release Drafter
 
-Creates a drafted release based on the labels, title and description of the PR.
+Automatically drafts a release based on PR labels, title, and description, simplifying the release process.
 
 ### Terraform Validation
 
-Verifies the terraform code adheres to best practises and has secure defaults set.
+Validates Terraform code to ensure adherence to best practices and security standards.
+
+### Changelog Update
+
+Automatically updates `CHANGELOG.md` when a new release is published, keeping version history up to date.
+
+## Repository Files
+
+### `.gitignore`
+
+Maintains consistency with our module structure and pre-commit setup.
+_Note: OS-specific or IDE-specific ignores are excluded; users should configure these in their global `.gitignore` file._
+
+### `LICENSE`
+
+Ensures that all repositories include the Apache License Version 2.0 for open-source compliance.
+
+### `CONTRIBUTING.md`
+
+Provides clear guidelines on how to contribute, ensuring a structured and efficient collaboration process.
+
+### `.pre-commit-config.yaml`
+
+Includes a pre-commit configuration to streamline local development by catching simple issues before creating a PR.
+
+### Pull Request Template
+
+Standardizes PR submissions by guiding contributors to provide essential details, improving the review process.
 
-### Update changelog
+### Issue Templates
 
-Updates the CHANGELOG.md when a release gets published.
+Defines structured templates for bug reports, feature requests, and general questions to ensure clear and complete issue descriptions.

sync-root/.github/workflows/release-drafter.yaml

@@ -10,6 +10,7 @@ on:
       - master
     paths-ignore:
       - .github/**
+      - .gitignore
       - .pre-commit-config.yaml
       - CHANGELOG.md
       - CONTRIBUTING.md

sync-root/.github/workflows/terraform-validation.yaml

@@ -127,7 +127,7 @@ jobs:
           working-dir: .
         continue-on-error: true # added this to prevent a PR from a remote fork failing the workflow
 
-  # If the recursive flag is set to true, the action will not update the main README.md file. 
+  # If the recursive flag is set to true, the action will not update the main README.md file.
   # Therefore we need to run the action twice, once for the root module and once for the modules directory
   docs-modules:
     runs-on: ubuntu-latest