Merge pull request #31 from Seasawher/develop

add notify(boolean) outputs

Author: Seasawher

.github/workflows/test.yaml

@@ -55,10 +55,20 @@ jobs:
           lake_package_directory: "./test/Foo"
 
       - name: output assertion of latest_lean
-        run: |
+        run: | # bat
           echo "Latest Lean version: ${{ steps.update.outputs.latest_lean }}"
           if [[ ! "${{ steps.update.outputs.latest_lean }}" =~ ^v ]]; then
             echo "Error: The latest_lean output should start with 'v'"
             exit 1
           fi
-          echo "latest_lean output test passed"
+          echo "latest_lean output test passed"
+
+      - name: output assertion of notify
+        run: | # bat
+          echo "Notify status: ${{ steps.update.outputs.notify }}"
+          if [[ "${{ steps.update.outputs.notify }}" != "true" ]]; then
+            echo "Error: The notify output should be 'true' for this test case"
+            echo "This test should have updates available with a successful build"
+            exit 1
+          fi
+          echo "notify output test passed"

README.md

@@ -176,3 +176,10 @@ Description of each value:
 
 The latest Lean release version, including both stable and pre-release versions.
 
+### `notify`
+
+Indicates whether there is an event worth notifying the user about.
+Returns `true` in the following cases:
+* When updates are available and the build succeeds. However, if `update_if_modified` is set to `lean-toolchain`, this is only true when the Lean version has been updated.
+* When updates are available and the build fails.
+Returns `false` in all other cases.

action.yml

@@ -66,6 +66,14 @@ outputs:
     description: | # markdown
       The latest Lean release version, including both stable and pre-release versions.
     value: ${{ steps.record-latest-lean.outputs.latest_lean }}
+  notify:
+    description: | # markdown
+      Indicates whether there is an event worth notifying the user about.
+      Returns `true` in the following cases:
+        * When updates are available and the build succeeds. However, if `update_if_modified` is set to `lean-toolchain`, this is only true when the Lean version has been updated.
+        * When updates are available and the build fails.
+      Returns `false` in all other cases.
+    value: ${{ steps.record-notify.outputs.notify }}
 runs:
   using: "composite"
   steps:
@@ -140,6 +148,25 @@ runs:
       shell: bash
       working-directory: ${{ inputs.lake_package_directory }}
 
+    - name: Record the notify status
+      id: record-notify
+      run: |
+        : Record the notify status
+        if [ "${{ steps.check-update.outputs.files_changed }}" == "false" ]; then
+          echo "No updates available, no need to notify"
+          echo "notify=false" >> $GITHUB_OUTPUT
+        elif [ "${{ steps.build-lean.outcome }}" == "success" ] && [ "${{ steps.check-update.outputs.do_update }}" == "true" ]; then
+          echo "Updates available and build successful - should notify"
+          echo "notify=true" >> $GITHUB_OUTPUT
+        elif [ "${{ steps.build-lean.outcome }}" == "failure" ]; then
+          echo "Updates available but build failed - should notify"
+          echo "notify=true" >> $GITHUB_OUTPUT
+        else
+          echo "No need to notify in this case"
+          echo "notify=false" >> $GITHUB_OUTPUT
+        fi
+      shell: bash
+
     # ------------------------- #
     # when update is successful #
     # ------------------------- #

scripts/checkChanges.js

@@ -18,26 +18,30 @@ if (!allCandidates.includes(updateIfModified)) {
   process.exit(1);
 }
 
-try {
-  const updateIfModifiedDiff = execSync(`git diff -w ${updateIfModified}`, { encoding: 'utf8' });
-  doUpdate = updateIfModifiedDiff.length > 0;
-} catch (error) {
-  console.error(`Error checking diff for ${updateIfModified}:`, error);
-  doUpdate = false;
-}
-
 // Check all candidate files for changes
+const fileChanges = {};
 allCandidates.forEach(candidate => {
   try {
     const diff = execSync(`git diff -w ${candidate}`, { encoding: 'utf8' });
+    fileChanges[candidate] = diff.length > 0;
     if (diff.length > 0) {
       changedFiles.push(candidate);
     }
   } catch (error) {
     console.error(`Error checking diff for ${candidate}:`, error);
+    fileChanges[candidate] = false;
   }
 });
 
+// Determine if updates should proceed based on the specified update_if_modified value
+if (updateIfModified === 'lean-toolchain') {
+  // If update_if_modified is lean-toolchain, only proceed if lean-toolchain has changed
+  doUpdate = fileChanges['lean-toolchain'];
+} else if (updateIfModified === 'lake-manifest.json') {
+  // If update_if_modified is lake-manifest.json, proceed if any file has changed
+  doUpdate = changedFiles.length > 0;
+}
+
 // Create result object
 const result = {
   files_changed: changedFiles.length > 0,