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 #5809

Merged
merged 2 commits into from
Aug 16, 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: false # line length
MD024: # no-duplicate-heading Multiple headings with the same content
siblings_only: true
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
Copy link
Member

Choose a reason for hiding this comment

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

Don't we want to keep the path filter on this?

Copy link
Member Author

Choose a reason for hiding this comment

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

I kept it off with the idea that we would enable other linters. Trying to manage the paths becomes unfeasible when you start doing this.


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.

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

This file was deleted.

2 changes: 1 addition & 1 deletion samples/aspnetapp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ You may notice that the sample includes a [health check](https://learn.microsoft

## Build image with the SDK

The easiest way to [build images is with the SDK](https://github.com/dotnet/sdk-container-builds).
The easiest way to [build images is with the SDK](https://github.com/dotnet/sdk-container-builds).

```console
dotnet publish /p:PublishProfile=DefaultContainer
Expand Down
4 changes: 2 additions & 2 deletions samples/releasesapi/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Release Json Report API

This app demonstrates publishing an app as [native AOT](https://learn.microsoft.com/dotnet/core/deploying/native-aot/) in containers.
This app demonstrates publishing an app as [native AOT](https://learn.microsoft.com/dotnet/core/deploying/native-aot/) in containers.

> [!NOTE]
> The base images used by this sample are in preview.
Expand All @@ -23,7 +23,7 @@ It exposes two endpoints:

## App

The app is intended as a sort of compliance report for .NET. The report includes supported major releases and those recently out of support. It includes the latest and latest security patch versions for each of those major releases.
The app is intended as a sort of compliance report for .NET. The report includes supported major releases and those recently out of support. It includes the latest and latest security patch versions for each of those major releases.

This same information is available from the [release JSON](https://github.com/dotnet/core/blob/main/release-notes/releases-index.json) files that the team maintains, but that requires a bit of code to provide the same report.

Expand Down