feat: implement release please pipeline #1106

.github/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "6.0.0"
+}

.github/release-please-config.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "pull-request-header": "chore: release",
+  "draft-pull-request": true,
+  "versioning": "default",
+  "changelog-sections": [
+    { "type": "feat", "hidden": false, "section": "Features" },
+    { "type": "fix", "hidden": false, "section": "Bug Fixes" },
+    { "type": "chore", "hidden": false, "section": "Miscellaneous Chores" },
+    { "type": "build", "hidden": false, "section": "Miscellaneous Chores" },
+    { "type": "ci", "hidden": false, "section": "Miscellaneous Chores" },
+    { "type": "docs", "hidden": false, "section": "Docs" }
+  ],
+  "packages": {
+    ".": {
+      "release-type": "simple",
+      "include-v-in-release-name": false,
+      "include-v-in-tag": false,
+      "changelog-path": "doc/CHANGELOG.md",
+      "bump-minor-pre-major": true
+    }
+  }
+}

.github/workflows/release-please.yml

@@ -0,0 +1,22 @@
+---
+name: "On-Push-Main"
+on:
+  push:
+  workflow_dispatch:
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      version: ${{ steps.release.outputs.version }}
+    steps:
+      - id: release
+        uses: googleapis/release-please-action@v4
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_GH_TOKEN }}
+          config-file: .github/release-please-config.json
+          manifest-file: .github/.release-please-manifest.json

.overcommit.yml

@@ -5,3 +5,12 @@ PreCommit:
     command: ['bash', '-c', 'docker run --rm -v "$(pwd):/workdir" trufflesecurity/trufflehog:latest git file:///workdir --since-commit HEAD --no-verification --fail']
     problem_on_unmodified_line: true
     description: 'Detect secrets using TruffleHog (Docker)'
+CommitMsg:
+  CapitalizedSubject:
+    enabled: false
+  MessageFormat:
+    enabled: true
+    pattern: '^(build|chore|ci|docs|feat|fix|refactor|revert|style|test)(\([a-zA-Z0-9_-]+\))?!?: .+( #[0-9]+)?$'
+    expected_pattern_message: '<type><(optional scope)><! if breaking change>: <description> <optional #ticket number> for more details visit https://www.conventionalcommits.org/'
+    sample_message: 'feat(overcommit): implement new overcommit commit-msg hook #1106'
+    description: 'Check if commit is a conventional commit'

doc/CONTRIBUTING.md

@@ -24,9 +24,16 @@ All you need to do is adhere to the Definion of Done below
 
 - Use spaces instead of tabs
 
+#### Commit Guidelines
+- [Conventional Commits](https://www.conventionalcommits.org/)
+
+
 #### Entity Relationship Diagram
 To gain an overview of the project an ERD might help, generate one with:
 
 ```shell
 bundle exec erd
 ```
+
+#### Hooks
+- To install the pre-commit hooks run `overcommit --install`