Conversation
35b98c3 to
3b3e594
Compare
4478116 to
97fd115
Compare
ea300df to
f8d712b
Compare
05008e7 to
c4cfe1c
Compare
* Exclude `eng/common` since these files are from https://github.com/dotnet/arcade. * Add a `<!-- markdownlint-disable -->` directive for files in `reports/net9to10/`
c4cfe1c to
6fc1db8
Compare
There was a problem hiding this comment.
Pull request overview
This PR re-enables previously disabled markdownlint rules and updates Markdown content/configuration to bring the repo back into compliance, while excluding Arcade-sourced Markdown and suppressing linting for generated net9→10 report files.
Changes:
- Re-enabled multiple
markdownlintrules in.markdownlint.jsoncand updated the GitHub Actions workflow to use an ignore file. - Added
.markdownlintignore(excludingeng/common/) and added<!-- markdownlint-disable -->to generatedreports/net9to10/*_report.mdfiles. - Fixed MD059 (descriptive link text) and MD047 (single trailing newline) violations across several docs/reports.
Reviewed changes
Copilot reviewed 20 out of 21 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/benchmarks/gc/GC.Infrastructure/README.md | Updates link text to satisfy MD059; minor wording tweaks. |
| src/benchmarks/gc/GC.Infrastructure/Notebooks/README.md | Makes link text descriptive for MD059 compliance. |
| docs/benchmarkdotnet.md | Makes link text descriptive for MD059 compliance. |
| reports/net9to10/README.md | Fixes formatting/newline consistency for lint compliance. |
| reports/net9to10/*_report.md | Adds markdownlint-disable directives and fixes trailing-newline/formatting issues in generated reports. |
| .markdownlintignore | Introduces ignore list (notably eng/common/). |
| .markdownlint.jsonc | Re-enables previously-disabled rules (MD001/MD012/MD031/MD033/MD036/MD047/MD051/MD052/MD059). |
| .github/workflows/markdownlint.yml | Uses .markdownlintignore via --ignore-path when running markdownlint. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| 1. Legend column should contain the name of the ASP.NET benchmark followed by an underscore and the name of the OS. | ||
| 2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found [here](#how-to-add-new-benchmarks). | ||
| 2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found in the next section. |
There was a problem hiding this comment.
This change removes the in-doc anchor link that previously navigated readers to the relevant section. To keep the document easy to navigate while satisfying MD059, consider linking directly with descriptive text (e.g., a link to the “How To Add New Benchmarks” section) instead of referring to “the next section” without a link.
| 2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found in the next section. | |
| 2. The Base CommandLine is the base crank command that's run. More details about how to appropriately set this can be found in the [How To Add New Benchmarks](#how-to-add-new-benchmarks) section. |
| - name: Run markdownlint | ||
| run: | | ||
| markdownlint --config ./.markdownlint.jsonc '**/*.md' | ||
| markdownlint --config ./.markdownlint.jsonc --ignore-path ./.markdownlintignore '**/*.md' |
There was a problem hiding this comment.
Since the workflow now relies on --ignore-path ./.markdownlintignore, consider adding .markdownlintignore to the on.pull_request.paths filter so updates to the ignore list will also trigger this workflow (otherwise changes to the ignore file alone won’t be validated).
Enable the rules disabled in #4995
eng/commonsince these files are from https://github.com/dotnet/arcade.<!-- markdownlint-disable -->directive for files inreports/net9to10/Fix #4996