compose workflows

Author: KevinVlaanderen

.github/workflows/build-module.yml

@@ -1,11 +1,6 @@
-name: Export module package
+name: Build module
 on:
-  push:
-    paths:
-      - "module/**"
-  pull_request:
-    paths:
-      - "module/**"
+  workflow_call:
   workflow_dispatch:
 jobs:
   build:

.github/workflows/build-widget.yml

@@ -1,17 +1,12 @@
 name: Build widget
 on:
-  push:
-    paths:
-      - "widget/**"
-  pull_request:
-    paths:
-      - "widget/**"
+  workflow_call:
   workflow_dispatch:
 defaults:
   run:
     working-directory: ./widget
 jobs:
-  build-widget:
+  build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

.github/workflows/pull-request.yml

@@ -0,0 +1,13 @@
+name: Pull request
+on:
+  pull_request:
+jobs:
+  build-module:
+    uses: ./.github/workflows/build-module.yml
+    secrets: inherit
+  build-widget:
+    uses: ./.github/workflows/build-widget.yml
+    secrets: inherit
+  snyk:
+    uses: ./.github/workflows/snyk.yml
+    secrets: inherit

.github/workflows/push-stable.yml

@@ -0,0 +1,13 @@
+name: Push to stable branch
+
+on:
+  push:
+    branches: [ "master", "mx8" ]
+
+jobs:
+  snyk:
+    uses: ./.github/workflows/snyk.yml
+    with:
+      command: "monitor"
+      suffix: -${{ github.ref_name }}
+    secrets: inherit

.github/workflows/snyk.yml

@@ -1,12 +1,19 @@
-name: Run Snyk scan
+name: Run Snyk scans
 
 on:
-  push:
-    branches: [ "master" ]
+  workflow_call:
+    inputs:
+      command:
+        type: string
+        required: false
+        default: 'test'
+      suffix:
+        type: string
+        required: false
   workflow_dispatch:
 
 jobs:
-  snyk-test:
+  snyk-test-gradle:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
@@ -15,5 +22,5 @@ jobs:
         env:
           SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
         with:
-          command: monitor
-          args: --project-name="MxPushNotifications" --file=build.gradle
+          command: ${{ inputs.command }}
+          args: --project-name="gradle${{ inputs.suffix }}" --file=module/build.gradle

README.md

@@ -58,4 +58,7 @@ The userlibs for the PushNotifications module are not part of the repo.
 To fetch them, run the `updateUserLibs` task after checking out the repo (and after switching branches).
 
 Changes to the `userlib` folder are ignored by git.
-If you make any changes to the libraries required by other modules, you must commit these explicitly, using e.g. `git add -f <path>`.
+If you make any changes to the libraries required by other modules, you must commit these explicitly, using e.g. `git add -f <path>`.
+
+Although the widget is built as part of the CI workflows, it is not integrated into the module.
+Newly built widget versions must always be committed manually.