Skip to content

Commit 4c1ed77

Browse files
committed
Move comment to appropriate location
The "Check Prettier Formatting" workflow is configured to only run when relevant files are modified by the use of path filters. Due to Prettier being a general purpose formatting tool with coverage for an array of languages, and due to the fact that multiple file extensions may be used for files of a given language, the paths filter is extensive. It is based on the code Prettier uses to identify files. In order to facilitate maintenance of the workflow, a comment was added to document the source upon which the paths filter is based. The paths filter must be defined redundantly for both the `push` and `pull_request` event triggers. The decision was made to only add the comment to one instance of the code. Somehow it ended up being added to the second instance, where the maintainer is less likely to see it. It is hereby moved to the first instance.
1 parent 380bcc0 commit 4c1ed77

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

.github/workflows/check-prettier-formatting-task.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ on:
1111
- "Taskfile.ya?ml"
1212
- "**/.prettierignore"
1313
- "**/.prettierrc*"
14+
# Prettier-covered file patterns are defined by:
15+
# https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml
16+
#
1417
# CSS
1518
- "**.css"
1619
- "**.wxss"
@@ -115,8 +118,6 @@ on:
115118
- "Taskfile.ya?ml"
116119
- "**/.prettierignore"
117120
- "**/.prettierrc*"
118-
# Prettier-covered file patterns are defined by:
119-
# https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml
120121
# CSS
121122
- "**.css"
122123
- "**.wxss"

workflow-templates/check-prettier-formatting-task.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ on:
1111
- "Taskfile.ya?ml"
1212
- "**/.prettierignore"
1313
- "**/.prettierrc*"
14+
# Prettier-covered file patterns are defined by:
15+
# https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml
16+
#
1417
# CSS
1518
- "**.css"
1619
- "**.wxss"
@@ -115,8 +118,6 @@ on:
115118
- "Taskfile.ya?ml"
116119
- "**/.prettierignore"
117120
- "**/.prettierrc*"
118-
# Prettier-covered file patterns are defined by:
119-
# https://github.com/github-linguist/linguist/blob/main/lib/linguist/languages.yml
120121
# CSS
121122
- "**.css"
122123
- "**.wxss"

0 commit comments

Comments
 (0)