Merge pull request #784 from tj-actions/chore/update-readme

tj-actions · Nov 7, 2022 · 77f03d2 · 77f03d2
2 parents de6d1ed + a236f54
commit 77f03d2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -52,9 +52,13 @@ Retrieve all changed files and directories relative to the target branch or the
 name: CI
 
 on:
+  # Compare the preceeding commit of main -> to the current commit of the main branch.
+  # (Note: To compare changes between the last pushed commit to the remote main branch set `since_last_remote_commit: true`)
   push:
     branches:
       - main
+  # Compare the last commit of main -> to the current commit of a PR branch. 
+  # (Note: To compare changes between the last pushed commit to the remote PR branch set `since_last_remote_commit: true`)
   pull_request:
     branches:
       - main