bug: Markdownlint Action Ignore Templates#53
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the markdownlint GitHub Action workflow to properly ignore template files that should not be linted. The issue was that the .markdownlintignore file was not being respected, so the solution adds explicit files_ignore patterns to the tj-actions/changed-files action configuration to prevent ignored files from being passed to the linter.
Changes:
- Added
files_ignoreparameter to the changed-files action to exclude HuggingFace template files and mkdocs.yaml from markdown linting
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
egrace479
reviewed
Jan 26, 2026
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
egrace479
approved these changes
Jan 26, 2026
egrace479
added a commit
to Imageomics/Imageomics-guide
that referenced
this pull request
Jan 27, 2026
Pull from Collab Guide [PR 53](Imageomics/Collaborative-distributed-science-guide#53) * Include ignore in config * test: template that should be ignored * Specifically ignore files in lint.yaml * test: Remove test file * test: ensure config file is working with test md file * test: fix extra errors in the test md file * test: fix un-intended errors in test file * test: cleanup * Remove redundant yaml ignore from linter Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> --------- Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
egrace479
added a commit
to ABC-Center/ABC-guide
that referenced
this pull request
Jan 27, 2026
Pull from Collab Guide [PR 53](Imageomics/Collaborative-distributed-science-guide#53) * Include ignore in config * test: template that should be ignored * Specifically ignore files in lint.yaml * test: Remove test file * test: ensure config file is working with test md file * test: fix extra errors in the test md file * test: fix un-intended errors in test file * test: cleanup * Remove redundant yaml ignore from linter Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> --------- Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
egrace479
added a commit
to Imageomics/Imageomics-guide
that referenced
this pull request
Jan 28, 2026
Pull from Collab Guide [PR 53](Imageomics/Collaborative-distributed-science-guide#53) * Include ignore in config * test: template that should be ignored * Specifically ignore files in lint.yaml * test: Remove test file * test: ensure config file is working with test md file * test: fix extra errors in the test md file * test: fix un-intended errors in test file * test: cleanup * Remove redundant yaml ignore from linter Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> --------- Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
egrace479
added a commit
to ABC-Center/ABC-guide
that referenced
this pull request
Jan 28, 2026
Pull from Collab Guide [PR 53](Imageomics/Collaborative-distributed-science-guide#53) * Include ignore in config * test: template that should be ignored * Specifically ignore files in lint.yaml * test: Remove test file * test: ensure config file is working with test md file * test: fix extra errors in the test md file * test: fix un-intended errors in test file * test: cleanup * Remove redundant yaml ignore from linter Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> --------- Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The markdown lint action was not ignoring files listed in the
markdownlintignore. To ensure the linter ignores these files we must clearly define them in the linters yaml file by including what files to ignore.Testing
Below was tested with an added file
docs/wiki-guides/HF_test_Template.mdwhich had syntax the linter would raise errors to and we can see the linter ignored the file.Below we can see what happens before our solution was implemented and we can see the linter was not working and instead raising errors about
HF_test_Template.mdVerification of the configuration file being respected below:
Here is the test MD file we used to ensure the linter respects our rules in
mardownlint.json.Closes #52