document the change

xarray-contrib · Jul 7, 2024 · 4609cbe · 4609cbe
1 parent 9816159
commit 4609cbe
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -75,6 +75,8 @@ In case you don't like the default title for new issues, this setting can be use
     issue-title: "Nightly CI failed"
 ```
 
+The title can also be parametrized, in which case a separate issue will be opened for each variation of the title.
+
 ### issue label
 
 optional. Default: `CI`

diff --git a/action.yaml b/action.yaml
@@ -8,7 +8,8 @@ inputs:
     required: true
   issue-title:
     description: >-
-      Title of issue being created or updated
+      Title of issue being created or updated. Can be a parametrized string, in which case
+      a new issue will be opened for all variations.
     required: false
     default: "⚠️ Nightly upstream-dev CI failed ⚠️"
   issue-label: