From 4d5f9ba39c37a18c76ea27fbe3d8effa480fee3e Mon Sep 17 00:00:00 2001
From: Le Minh Duc <minhducle.it@gmail.com>
Date: Sun, 1 Sep 2024 23:10:03 +0700
Subject: [PATCH] ci: add commitlint (#170)

---
 .commitlintrc                  | 37 +++++++++++++++++
 .github/workflows/pr-lint.yaml | 76 ++++++++++++++++++++++++++++++++++
 2 files changed, 113 insertions(+)
 create mode 100644 .commitlintrc
 create mode 100644 .github/workflows/pr-lint.yaml

diff --git a/.commitlintrc b/.commitlintrc
new file mode 100644
index 00000000..6572ee32
--- /dev/null
+++ b/.commitlintrc
@@ -0,0 +1,37 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "defaultIgnores": true,
+  "rules": {
+    "body-leading-blank": [1, "always"],
+    "body-max-line-length": [2, "always", 100],
+    "footer-leading-blank": [1, "always"],
+    "footer-max-line-length": [2, "always", 10000],
+    "header-max-length": [2, "always", 200],
+    "subject-case": [
+      2,
+      "never",
+      []
+    ],
+    "subject-empty": [2, "never"],
+    "subject-full-stop": [2, "never", "."],
+    "type-case": [2, "always", "lower-case"],
+    "type-empty": [2, "never"],
+    "type-enum": [
+      2,
+      "always",
+      [
+        "build",
+        "chore",
+        "ci",
+        "docs",
+        "feat",
+        "fix",
+        "perf",
+        "refactor",
+        "revert",
+        "style",
+        "test"
+      ]
+    ]
+  }
+}
diff --git a/.github/workflows/pr-lint.yaml b/.github/workflows/pr-lint.yaml
new file mode 100644
index 00000000..ebf97e5f
--- /dev/null
+++ b/.github/workflows/pr-lint.yaml
@@ -0,0 +1,76 @@
+name: "Lint PR"
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  pull-requests: write
+
+jobs:
+  pr-title:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        id: lint_pr_title
+        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
+
+  commitlint:
+    name: Validate commit messages
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - uses: actions/checkout@v4
+      - uses: wagoid/commitlint-github-action@v6
+        id: commitlint
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          configFile: ./.commitlintrc
+      - uses: buildingcash/json-to-markdown-table-action@v1
+        if: always() && (steps.commitlint.outcome != 'success')
+        id: table
+        with:
+          json: ${{ steps.commitlint.outputs.results }}
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: always() && (steps.commitlint.outcome != 'success')
+        with:
+          header: commitlint-error
+          message: |
+            **All commits** in this PR need to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and [.commitlintrc](${{ github.server_url }}/${{ github.repository }}/blob/${{ github.head_ref || github.ref_name }}/.commitlintrc).
+            Details:
+            ${{ steps.table.outputs.table }}
+
+      - if: ${{ steps.commitlint.outcome == 'success' }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: commitlint-error
+          delete: true