Skip to content

Commit d8143d7

Browse files
authored
[NFC] Improve docs for reusable workflow (#14761)
1 parent a6c8725 commit d8143d7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

.github/workflows/common.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ on:
1212
required: true
1313

1414
# The platforms to build on. Defaults to all.
15+
# To target specific platforms, pass a comma or space separated string of
16+
# platforms.
17+
#
18+
# Examples:
19+
# - build/test only for macOS: `macOS`
20+
# - build/test only for macOS and tvOS: `macOS, tvOS`
1521
platforms:
1622
type: string
1723
required: false
@@ -23,6 +29,9 @@ on:
2329
#
2430
# Platform options: [iOS, tvOS, macOS, watchOS, catalyst, visionOS]
2531
#
32+
# Note: Build-only platforms must be represented in the `platforms` input
33+
# (which defaults to all platforms) in order to take effect.
34+
#
2635
# Examples:
2736
# - build only for macOS: `macOS`
2837
# - build only for macOS and tvOS: `macOS, tvOS`

0 commit comments

Comments
 (0)