ci: add release notes and conventional pr titles (#13)

Author: mauriceackel

.github/dependabot.yml

@@ -2,17 +2,24 @@
 # https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
 version: 2
 updates:
-  # Maintain dependencies for Go modules
   - package-ecosystem: "gomod"
     directory: "/"
     schedule:
-      # Check for updates to Go modules every weekday
       interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
   - package-ecosystem: "gomod"
     directory: "/tools"
     schedule:
       interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "daily"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

.github/workflows/main.yml

@@ -0,0 +1,11 @@
+name: Main
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Test
+    uses: ./.github/workflows/test.yml

.github/workflows/pr.yml

@@ -0,0 +1,29 @@
+name: Pull Request
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - edited
+    branches:
+      - main
+
+jobs:
+  validate-pr-title:
+    name: Validate PR Title
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: PR Conventional Commit Validation
+        uses: ytanikin/[email protected]
+        with:
+          task_types: '["feat","fix","docs","test","refactor","ci","perf","chore","revert"]'
+          add_scope_label: 'true'
+          custom_labels: '{"feat": "feature", "fix": "fix", "docs": "documentation", "test": "test", "refactor": "refactor", "ci": "CI/CD", "perf": "performance", "chore": "chore", "revert": "revert"}'
+
+  test:
+    name: Test
+    uses: ./.github/workflows/test.yml

.github/workflows/release.yml

@@ -15,11 +15,13 @@ permissions:
 
 jobs:
   test:
+    name: Test
     uses: ./.github/workflows/test.yml
 
   release:
-    needs: test
+    name: Release
     runs-on: ubuntu-latest
+    needs: test
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:

.github/workflows/test.yml

@@ -2,16 +2,6 @@
 name: Tests
 
 on:
-  pull_request:
-    paths-ignore:
-      - 'README.md'
-  push:
-    branches:
-      - main
-    tags-ignore:
-      - 'v*'
-    paths-ignore:
-      - 'README.md'
   workflow_call:
 
 permissions:
@@ -36,7 +26,7 @@ jobs:
           version: latest
 
   generate:
-    name: Check documentation
+    name: Check Documentation
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -56,8 +46,8 @@ jobs:
 
   test:
     name: Terraform Provider Acceptance Tests
-    needs: build
     runs-on: ubuntu-latest
+    needs: build
     timeout-minutes: 15
     strategy:
       fail-fast: false
@@ -85,3 +75,17 @@ jobs:
         timeout-minutes: 10
       - name: Clean up
         run: docker stop openfga && docker rm openfga
+
+  check:
+    name: All Tests Succeeded
+    runs-on: ubuntu-latest
+    if: always()
+    needs:
+      - build
+      - generate
+      - test
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

.goreleaser.yml

@@ -59,6 +59,6 @@ release:
   # If you want to manually examine the release before its live, uncomment this line:
   # draft: true
 changelog:
-  disable: true
+  use: github-native
 git:
   prerelease_suffix: "-pre"