From de4c710501a483c848d5af17185228fb04a53488 Mon Sep 17 00:00:00 2001
From: Vaclav Pavlin <vaclav.pavlin@gmail.com>
Date: Fri, 28 Apr 2023 14:25:39 +0200
Subject: [PATCH] feat:add commit message linter and PR template (#1677)

---
 .github/pull_request_template.md | 26 +++++++++++++++++
 .github/workflows/pr-lint.yml    | 50 ++++++++++++++++++++++++++++++++
 2 files changed, 76 insertions(+)
 create mode 100644 .github/pull_request_template.md
 create mode 100644 .github/workflows/pr-lint.yml

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 000000000..cdbb4d120
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,26 @@
+
+# Description
+<!--- Describe your changes to provide context for reviewrs -->
+
+# Changes
+
+<!-- List of detailed changes -->
+
+- [ ] ...
+- [ ] ...
+
+<!--
+## How to test
+
+1.
+1.
+1.
+
+-->
+
+
+<!--
+## Issue
+
+closes #
+-->
\ No newline at end of file
diff --git a/.github/workflows/pr-lint.yml b/.github/workflows/pr-lint.yml
new file mode 100644
index 000000000..22a5de4af
--- /dev/null
+++ b/.github/workflows/pr-lint.yml
@@ -0,0 +1,50 @@
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        id: lint_pr_title
+        with:
+          types: |
+            chore
+            docs
+            feat
+            fix
+            refactor
+            style
+            test
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: marocchino/sticky-pull-request-comment@v2
+        # When the previous steps fails, the workflow would stop. By adding this
+        # condition you can continue the execution with the populated error message.
+        if: always() && (steps.lint_pr_title.outputs.error_message != null)
+        with:
+          header: pr-title-lint-error
+          message: |
+            Hey there and thank you for opening this pull request! 👋🏼
+            
+            We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted.
+
+            Details:
+          
+            > ${{ steps.lint_pr_title.outputs.error_message }}
+
+      # Delete a previous comment when the issue has been resolved
+      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:   
+          header: pr-title-lint-error
+          delete: true