fix(ci): introduce pr validate/edit workflow (#1781)

bcgov · Feb 1, 2024 · 53dc33d · 53dc33d
1 parent fddf4ba
commit 53dc33d
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 39 deletions.
diff --git a/.github/workflows/pr-open.yml b/.github/workflows/pr-open.yml
@@ -10,45 +10,6 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  # PR only, skip for merge_group
-  conventional-commits:
-    name: Conventional Commits
-    if: github.event_name == 'pull_request'
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: amannn/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  # PR only, skip for merge_group
-  pr-description-add:
-    name: PR Description Add
-    if: github.event_name == 'pull_request'
-    env:
-      DOMAIN: apps.silver.devops.gov.bc.ca
-      PREFIX: ${{ github.event.repository.name }}
-    runs-on: ubuntu-22.04
-    permissions:
-      pull-requests: write
-    timeout-minutes: 1
-    steps:
-      - uses: bcgov-nr/[email protected]
-        with:
-          add_markdown: |
-            ---
-
-            Thanks for the PR!
-
-            Deployments, as required, will be available below:
-            - [Frontend](https://${{ env.PREFIX }}-${{ github.event.number }}-frontend.${{ env.DOMAIN }})
-            - [Backend](https://${{ env.PREFIX }}-${{ github.event.number }}-frontend.${{ env.DOMAIN }}/api)
-
-            Please create PRs in draft mode.  Mark as ready to enable:
-            - [Analysis Workflow](https://github.com/${{ github.repository }}/actions/workflows/analysis.yml)
-
-            After merge, new images are deployed in:
-            - [Merge Workflow](https://github.com/${{ github.repository }}/actions/workflows/merge.yml)
-
   # Find initial PR number (for merge queues)
   vars:
     name: Set Variables

diff --git a/.github/workflows/pr-validate.yml b/.github/workflows/pr-validate.yml
@@ -0,0 +1,62 @@
+name: PR Validate
+
+on:
+  pull_request:
+    types: [edited, opened, reopened]
+
+concurrency:
+  # Cancel in progress for PR open and close, but not merge_group
+  group: ${{ github.workflow }}-${{ github.event.number || github.event.merge_group.base_sha }}
+  cancel-in-progress: true
+
+jobs:
+  dump:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Dump context
+        uses: utenx/gh-dump-context@v1
+        with:
+          context: github
+
+  # PR only, skip for merge_group
+  conventional-commits:
+    name: Conventional Commits
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: amannn/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - if: failure() && !success()
+        run: |
+          echo "Please use conventional commits in your PR title and re-run this job."
+          echo "https://www.conventionalcommits.org/en/v1.0.0/"
+          exit 1
+
+  # PR only, skip for merge_group
+  pr-description-add:
+    name: PR Description Add
+    env:
+      DOMAIN: apps.silver.devops.gov.bc.ca
+      PREFIX: ${{ github.event.repository.name }}
+    runs-on: ubuntu-22.04
+    permissions:
+      pull-requests: write
+    timeout-minutes: 1
+    steps:
+      - uses: bcgov-nr/[email protected]
+        with:
+          add_markdown: |
+            ---
+
+            Thanks for the PR!
+
+            Deployments, as required, will be available below:
+            - [Frontend](https://${{ env.PREFIX }}-${{ github.event.number }}-frontend.${{ env.DOMAIN }})
+            - [Backend](https://${{ env.PREFIX }}-${{ github.event.number }}-frontend.${{ env.DOMAIN }}/api)
+
+            Please create PRs in draft mode.  Mark as ready to enable:
+            - [Analysis Workflow](https://github.com/${{ github.repository }}/actions/workflows/analysis.yml)
+
+            After merge, new images are deployed in:
+            - [Merge Workflow](https://github.com/${{ github.repository }}/actions/workflows/merge.yml)