Document additional requirement.

ansible-community · Nov 9, 2022 · 5241d0a · 5241d0a
1 parent 1c9d960
commit 5241d0a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -109,7 +109,9 @@ Extra command to invoke before ansible-test **(OPTIONAL)**
 Whether to use change detection for pull requests. If set to `true`, will
 use change detection to determine changed files against the target branch,
 and will not upload code coverage results. If the invocation is not from a
-pull request, this option is ignored. **(DEFAULT: `false`)**
+pull request, this option is ignored. Note that this requires
+`collection-src-directory` to be empty or something ending with
+`ansible_collections/{namespace}/{name}`. **(DEFAULT: `false`)**
 
 
 ### `python-version`

diff --git a/action.yml b/action.yml
@@ -50,7 +50,9 @@ inputs:
       Whether to use change detection for pull requests. If set to `true`, will
       use change detection to determine changed files against the target
       branch, and will not upload code coverage results. If the invocation is
-      not from a pull request, this option is ignored.
+      not from a pull request, this option is ignored. Note that this requires
+      `collection-src-directory` to be empty or something ending with
+      `ansible_collections/{namespace}/{name}`.
     default: 'false'
   python-version:
     description: >-