doc: improve comments

leanprover · Jun 10, 2024 · e4239c4 · e4239c4
1 parent 385a1cb
commit e4239c4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/action.yml b/action.yml
@@ -64,13 +64,13 @@ inputs:
 outputs:
   build-status:
     description: |
-      The status of the `lake build`.
-      Allowed values: "NOT_RUN" | "SUCCESS" | "FAILURE".
+      The status of the `lake build` step.
+      Allowed values: "SUCCESS" | "FAILURE" | "NOT_RUN".
     value: ${{ steps.set-output-parameters.outputs.build-status }}
   test-status:
     description: |
-      The status of the `lake test`.
-      Allowed values: "NOT_RUN" | "SUCCESS" | "FAILURE".
+      The status of the `lake test` step.
+      Allowed values: "SUCCESS" | "FAILURE" | "NOT_RUN".
     value: ${{ steps.set-output-parameters.outputs.test-status }}
 
 runs:

diff --git a/scripts/set_output_parameters.sh b/scripts/set_output_parameters.sh
@@ -5,7 +5,7 @@ echo "::group::Set Output Parameters"
 
 # If the BUILD_STATUS environment variable is not set,
 # set the `build-status` output parameter to NOT_RUN
-# Otherwise, set it to the value of the BUILD_STATUS environment variable
+# Otherwise, set it to the output of the `lake build` step (the BUILD_STATUS environment variable)
 if [ "$BUILD_STATUS" = "" ]; then
     echo "build-status=NOT_RUN" >>"$GITHUB_OUTPUT"
 else
@@ -14,10 +14,11 @@ fi
 
 # If the TEST_STATUS environment variable is not set,
 # set the `test-status` output parameter to NOT_RUN
-# Otherwise, set it to the value of the TEST_STATUS environment variable
+# Otherwise, set it to the output of the `lake test` step (the TEST_STATUS environment variable)
 if [ "$TEST_STATUS" = "" ]; then
     echo "test-status=NOT_RUN" >>"$GITHUB_OUTPUT"
 else
     echo "test-status=$TEST_STATUS" >>"$GITHUB_OUTPUT"
 fi
+
 echo "::endgroup::"