feat(conventional-commits): update workflow to validate PR titles against Conventional Commits

Author: TartanLeGrand

.github/workflows/conventional-commits.yaml

@@ -1,15 +1,18 @@
-name: Conventional Commits
+name: "Lint PR"
 
 on:
-  pull_request:
-    branches:
-      - main
+  workflow_call:
+    secrets:
+      GITHUB_TOKEN:
+        required: true
 
 jobs:
-  build:
-    name: Conventional Commits
+  validate-pr-title:
+    name: Validate PR title
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: read
     steps:
-      - uses: actions/checkout@v4
-
-      - uses: webiny/[email protected]
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -11,4 +11,7 @@ This workflow builds a Docker image from a Dockerfile. It is a reusable workflow
 This workflow uses the [release-please-action](https://github.com/googleapis/release-please-action) to automate the release of a project.
 
 ### [Publish NPM Package](./publish-npm)
-This workflow publishes an NPM package to the NPM registry.
+This workflow publishes an NPM package to the NPM registry.
+
+### [Conventional Commits](./conventional-commits)
+This workflow checks that pull request titles follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.

conventional-commits/README.md

@@ -0,0 +1,28 @@
+# Conventional Commits
+
+This workflow checks that pull request titles follow the [Conventional Commits](https://www.conventionalcommits.org/) specification.
+
+## Secrets
+
+### `GITHUB_TOKEN`
+
+**Required** The GitHub token to use for authentication.
+
+## Example usage
+
+```yaml
+name: Lint PR Title
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - reopened
+
+jobs:
+  lint-pr-title:
+    uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/[email protected]
+    secrets:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```