Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch markdownlint GH action to use super-linter #4567

Merged
merged 1 commit into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/linters/.markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
default: true
MD013: # line length
code_block_line_length: 256
heading_line_length: 96
MD033: false # no inline HTML
31 changes: 31 additions & 0 deletions .github/workflows/lint-code-base.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Lint Code Base

on:
pull_request: null

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a change in behavior? Previously, linter was supposedly on for PRs with a list of file patterns.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is on for PRs with no specific file patterns (e.g. all PRs). The idea is it allows for the easy enablement of other linters supported by the super-linter. e.g. scripting, json, yml, etc.


permissions: {}

jobs:
run-lint:
runs-on: ubuntu-latest

permissions:
contents: read
packages: read
# To report GitHub Actions status checks
statuses: write

steps:
- name: Checkout code
uses: actions/checkout@v4
with:
# Full git history is needed to get a proper list of changed files within `super-linter`
fetch-depth: 0
- name: Lint Code Base
uses: github/super-linter@v6 # https://github.com/github/super-linter
env:
DEFAULT_BRANCH: main
FILTER_REGEX_EXCLUDE: eng/common/.*|eng/readme-templates/.*
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
VALIDATE_ALL_CODEBASE: false
VALIDATE_MARKDOWN: true
17 changes: 0 additions & 17 deletions .github/workflows/markdownlint-problem-matcher.json

This file was deleted.

29 changes: 0 additions & 29 deletions .github/workflows/markdownlint.yml

This file was deleted.

9 changes: 0 additions & 9 deletions .markdownlint.json

This file was deleted.