Skip to content

Commit 6d50180

Browse files
committed
Update YAML filename matching pattern reference link
Several significant files use the YAML language, but not the standard `.yml` or `.yaml` file extensions. In order to provide full coverage, "yamllint" and the paths filter of the "Check YAML" workflow must be configured with the patterns for these files. A list of filename patterns for the YAML language is maintained in the "Linguist" project. Even though Linguist is not used by this infrastructure, the data from the Linguist source code serves as a reference from which the list of patterns was derived. In order to facilitate maintenance of the list of file patterns, comments were added to the yamllint configuration file and the "Check YAML" workflow providing a link to the reference. In the Linguist project, the data for all programming languages is stored in a single data file, which makes that file less useful as a reference for a specific language, as is needed here. The linguist-languages package is generated from the Linguist language data file, with a separate file for each language, so it serves as a more convenient reference. The linguist-languages package is automatically generated, and is used by Prettier, so it is likely to be actively maintained. For these reasons, previously that package was used in the reference link. However, during a recent review of the reference links it was found that it no longer worked. For this reason, it was replaced with a link to the less useful Linguist source code. I have now performed an investigation into the situation with the linguist-languages package and found the new location of the content. So it is now possible to go back to using this superior reference. Several factors have resulted in the reference URL being different than before: * Repository transferred to a new owner * Default branch renamed * Data format changed from JSON to JavaScript
1 parent d4c2d9c commit 6d50180

File tree

4 files changed

+6
-12
lines changed

4 files changed

+6
-12
lines changed

.github/workflows/check-yaml-task.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ on:
1313
- ".yamllint*"
1414
- "poetry.lock"
1515
- "pyproject.toml"
16-
# Source: https://github.com/github-linguist/linguist/blob/f164d13fa618023ecf2d8f2ed9a6ce5fae731346/lib/linguist/languages.yml#L8237-L8260
17-
# (used by Prettier)
16+
# Source: https://github.com/ikatyang-collab/linguist-languages/blob/main/data/YAML.js (used by Prettier)
1817
- "**/.clang-format"
1918
- "**/.clang-tidy"
2019
- "**/.gemrc"
@@ -30,8 +29,7 @@ on:
3029
- ".yamllint*"
3130
- "poetry.lock"
3231
- "pyproject.toml"
33-
# Source: https://github.com/github-linguist/linguist/blob/f164d13fa618023ecf2d8f2ed9a6ce5fae731346/lib/linguist/languages.yml#L8237-L8260
34-
# (used by Prettier)
32+
# Source: https://github.com/ikatyang-collab/linguist-languages/blob/main/data/YAML.js (used by Prettier)
3533
- "**/.clang-format"
3634
- "**/.clang-tidy"
3735
- "**/.gemrc"

.yamllint.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ rules:
5353
check-keys: true
5454

5555
yaml-files:
56-
# Source: https://github.com/github-linguist/linguist/blob/f164d13fa618023ecf2d8f2ed9a6ce5fae731346/lib/linguist/languages.yml#L8237-L8260
57-
# (used by Prettier)
56+
# Source: https://github.com/ikatyang-collab/linguist-languages/blob/main/data/YAML.js (used by Prettier)
5857
- ".clang-format"
5958
- ".clang-tidy"
6059
- ".gemrc"

workflow-templates/assets/check-yaml/.yamllint.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,7 @@ rules:
5353
check-keys: true
5454

5555
yaml-files:
56-
# Source: https://github.com/github-linguist/linguist/blob/f164d13fa618023ecf2d8f2ed9a6ce5fae731346/lib/linguist/languages.yml#L8237-L8260
57-
# (used by Prettier)
56+
# Source: https://github.com/ikatyang-collab/linguist-languages/blob/main/data/YAML.js (used by Prettier)
5857
- ".clang-format"
5958
- ".clang-tidy"
6059
- ".gemrc"

workflow-templates/check-yaml-task.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ on:
1313
- ".yamllint*"
1414
- "poetry.lock"
1515
- "pyproject.toml"
16-
# Source: https://github.com/github-linguist/linguist/blob/f164d13fa618023ecf2d8f2ed9a6ce5fae731346/lib/linguist/languages.yml#L8237-L8260
17-
# (used by Prettier)
16+
# Source: https://github.com/ikatyang-collab/linguist-languages/blob/main/data/YAML.js (used by Prettier)
1817
- "**/.clang-format"
1918
- "**/.clang-tidy"
2019
- "**/.gemrc"
@@ -30,8 +29,7 @@ on:
3029
- ".yamllint*"
3130
- "poetry.lock"
3231
- "pyproject.toml"
33-
# Source: https://github.com/github-linguist/linguist/blob/f164d13fa618023ecf2d8f2ed9a6ce5fae731346/lib/linguist/languages.yml#L8237-L8260
34-
# (used by Prettier)
32+
# Source: https://github.com/ikatyang-collab/linguist-languages/blob/main/data/YAML.js (used by Prettier)
3533
- "**/.clang-format"
3634
- "**/.clang-tidy"
3735
- "**/.gemrc"

0 commit comments

Comments
 (0)